Поиск

Общее (general)

В этом разделе:

С помощью методов этого раздела вы можете:

Общее

В этом разделе:

С помощью методов этого раздела вы можете:

Введение

Wildberries API предоставляет продавцам инструменты для управления магазином и получения оперативной и статистической информации по протоколу HTTP REST API.

Главное преимущество API — возможность автоматизировать процессы за счет интеграции с информационными системами продавца: например, ERP, WMS, OMS, CRM. С WB API продавец может не управлять магазином через интерфейс сайта вручную.

Использование API для работы с магазином на Wildberries — это отличный способ:

  • автоматизировать рутинные процессы
  • получить доступ к актуальной информации
  • оптимизировать управление ассортиментом

Документация API предоставлена в формате Swagger OpenAPI и может быть использована для импорта в другие инструменты — например, Postman — или генерации клиентского кода на различных языках программирования с помощью Swagger CodeGen.

Для ручного тестирования API вы можете использовать:

  • Под ОС Windows — PostMan
  • Под ОС Linux — curl

Как начать работу с API

  1. Зарегистрируйтесь в личном кабинете Продавца.
  2. Перейдите в настройки магазина и создайте API-токен. Токен позволит получить доступ к WB API. Система токенов позволит вам контролировать, кто и как взаимодействует с вашими данными через API.
  3. Разработайте интеграцию с API с помощью собственных разработчиков или внешних специалистов. Вы также можете подключить партнёрские сервисы из нашего каталога решений для бизнеса.
Используйте метод проверки подключения, чтобы узнать, успешно ли доходят запросы до API и правильно ли настроен API-токен.

Практические советы:

  • Используйте документацию.
    Официальная документация WB API поможет разобраться в функциональности и возможностях API. В ней приводятся примеры возможных запросов и ответов, список возможных ошибок, лимиты запросов, правила безопасности и так далее.
  • Регулярно проверяйте работу интеграции.
    Следите, корректно ли вы передаете данные и какие вы получаете ответы, чтобы вовремя дорабатывать интеграцию. Не забывайте про ограничения и учитывайте лимиты на количество запросов.
  • Храните API-токен в безопасности.
    Не передавайте его третьим лицам без необходимости. Используйте только доверенные сервисы. При обнаружении подозрительной активности немедленно удалите и замените токен.
  • При необходимости обращайтесь в техническую поддержку.
  • Следите за новостями и изменениями WB API в:

Поддержка

Техническая поддержка происходит через диалоги в личном кабинете продавца. При создании нового обращения в техподдержку используйте категорию API.

Статус-коды HTTP

Основные статус-коды ответов на запросы в WB API:

Код Описание Как решить
200 Успешно
204 Удалено/Обновлено/Добавлено
400 Неправильный запрос Проверьте синтаксис запроса
401 Пользователь не авторизован Проверьте токен авторизации. Категория токена должна совпадать с категорией API. Также токен может:
• быть просрочен
• быть некорректным
• отсутствовать в запросе
403 Доступ запрещён Токен не должен быть сгенерирован удалённым пользователем. Доступ к методу не должен быть заблокирован. Если вы хотите использовать методы Джема, проверьте подписку в личном кабинете
404 Не найдено Проверьте URL запроса
409 Ошибка сохранения для части ссылок/обновления статуса/добавления сборочного задания/т.д. Проверьте данные запроса. Они должны отвечать требованиям и ограничениям сервиса
413 Превышен лимит объёма данных в запросе Уменьшите количество объектов в запросе
422 Отсутствие в запросе параметра nmId/Размер ставки не изменен/т.д. Проверьте данные запроса. Данные запроса не должны противоречить друг другу
429 Слишком много запросов Проверьте лимиты запросов и повторите запрос позже
5ХХ Внутренние ошибки сервиса Сервис недоступен. Повторите запрос позже или обратитесь в техническую поддержку
Обращайте внимание на поле details в ошибках 404 и 429 — туда мы добавляем полезную информацию по использованию методов

Пример ошибки:

{
  "title": "path not found",
  "detail": "Please consult the https://dev.wildberries.ru/openapi/api-information",
  ...
  "status": 404,
  "statusText": "Not Found",
  "timestamp": "2025-04-24T07:25:28Z"
}

Лимиты запросов

В WB API есть ограничения на скорость отправки запросов. Для равномерного распределения нагрузки используется алгоритм token bucket. Лимиты для конкретных методов API указаны в документации.

Например:

Лимит запросов на один аккаунт продавца для всех методов категории Маркетплейс:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

  • Период — временной интервал, в течение которого можно отправить максимальное количество запросов по лимиту.
  • Лимит — максимальное количество запросов за период. В примере за одну минуту можно отправить до 300 запросов. Запросы должны быть равномерно распределены по времени.
  • Интервал — промежуток времени для пауз между запросами. В примере должен составлять 60 секунд/300 запросов200 миллисекунд или 0.2 секунды. Используйте интервал, чтобы равномерно распределить отправку запросов.
  • Всплескburst, максимальное количество запросов, которое можно отправить одновременно, без интервальных пауз. Допустимый всплеск также возвращается в ответе в заголовке X-Ratelimit-Remaining. Он встречается во всех статусах ответов, кроме ошибки 429.

X-Ratelimit-Remaining — это количество запросов, которое можно выполнить на данный момент без пауз. Значение X-Ratelimit-Remaining уменьшается на единицу после каждого запроса. Если X-Ratelimit-Remaining равен 0 и вы сделали следующий запрос без задержки, в ответ вы получите ошибку 429. Значение X-Ratelimit-Remaining восстанавливается со временем.

Есть случаи, когда один запрос может быть равен нескольким. Например, если вы отправляете запросы категории Маркетплейс, запрос с ошибкой 409 будет равен 10 запросам с другими статусами. Тогда значение X-Ratelimit-Remaining снизится сразу на 10 единиц.

Если вы превысите скорость выполнения запросов, вы получите ошибку 429. В этом случае следующий запрос вы сможете сделать только после небольшого ожидания. Чтобы понять, сколько времени вам нужно ждать, используйте заголовки ответа 429:

  • X-Ratelimit-Retry — через сколько секунд вы можете повторить запрос. Если вы сделаете попытку раньше, вы все равно будете получать ошибку 429.
  • X-Ratelimit-Limit — максимальное значение всплеска запросов — burst, которое будет восстановлено через X-Ratelimit-Reset секунд.
  • X-Ratelimit-Reset — через сколько секунд допустимый всплеск запросов восстановится до максимального значения, указанного в X-Ratelimit-Limit.

Пример ответа:

HTTP/1.1 429 Too Many Requests
...
X-Ratelimit-Reset: 29
X-Ratelimit-Retry: 2
...
X-Ratelimit-Limit: 10

Авторизация

Чтобы авторизоваться в API, вам понадобится токен. Он действует 180 дней после создания. Добавляйте токен в заголовок запроса Authorization.

По пункту 9.9.6 оферты запрещена интеграция с порталом продавца без WB API

Правила использования токенов доступа к API

Подробнее о токенах можно узнать в инструкции в справочном центре

Для авторизации доступно четыре типа токенов:

Персональный токен

  • Назначение: Эксклюзивный токен с расширенными возможностями. Предназначен для того, чтобы предоставлять доступ к данным продавца только вашим собственным программам — в том числе корпоративным системам (on-premise), развёрнутым на собственной или арендованной инфраструктуре.
    Расширенные возможности означают, что со временем по персональному токену появится доступ к дополнительным категориям данных продавца, которые недоступны в базовом токене. Мы заранее расскажем об этом в новостях.
  • Подходит для:
    • собственных программных продуктов или систем компании, размещённых на своих или арендованных серверах
    • готовых ERP/CRM-систем в редакции on-premise, включая локальные (коробочные) версии 1С, развёрнутые на серверах компании или на компьютерах пользователей
  • Ограничения: Персональный токен даёт доступ к чувствительной информации, поэтому его нельзя передавать третьим лицам или использовать в облачных сервисах. При создании токена система покажет предупреждение об ответственности — его нужно принять, чтобы продолжить.
    Настройки токена вы выбираете самостоятельно. Если не уверены, какие параметры указать, уточните у разработчика или IT-специалиста, который отвечает за подключаемую систему.

Сервисный токен

  • Назначение: Специальный токен для подключения конкретного облачного сервиса из официального Каталога готовых решений для бизнеса на Wildberries.
  • Особенности: При создании токена вы выбираете сервис из Каталога, после чего все необходимые настройки, в том числе категории данных и уровни доступа, заполняются автоматически. Вам останется только подтвердить создание токена и передать его сервису.
  • Ограничения: Привязан к конкретному сервису и работает только с ним.

Базовый токен

  • Назначение: Вспомогательный токен, который предоставляет доступ к ограниченному набору данных продавца и используется во всех случаях, когда не подходит сервисный или персональный токен.
  • Подходит для:
    • тестирования интеграции на реальных данных перед запуском
    • остальных случаев, когда вы не можете использовать сервисный или персональный токен
  • Ограничения: Можно работать с ограниченным набором данных.

Тестовый токен

  • Назначение: Специальный токен для безопасного тестирования и отладки интеграций в изолированной среде — песочнице WB API.
  • Подходит для:
    • разработки и отладки интеграций без риска для реальных данных
    • изучения возможностей API и экспериментов с методами
    • проверки новых функций перед запуском в рабочей среде
  • Ограничения: Тестовый токен работает только с песочницей и даёт доступ к сгенерированным тестовым данным. Реальные данные магазина при этом недоступны. |

Как создать персональный, базовый или тестовый токен

Подробнее о создании Сервисного токена можно узнать в инструкции в справочном центре
  1. В личном кабинете перейдите в раздел Интеграции по API.
  2. Нажмите + Создать токен. Откроется окно создания токена с двумя вкладками. Для всех типов токенов, кроме сервисного, выберите вкладку Для интеграции вручную.
  3. Выберите тип токена.
  4. Для базового и персонального токенов:
  • Заполните название токена
  • Выберите, с какими категориями API вы будете работать
  • Задайте уровень доступа к данным: Чтение и запись или Только чтение
Категория Методы
Контент Категории, предметы и характеристики
Создание карточек товаров
Карточки товаров
Медиафайлы
Ярлыки
Аналитика Воронка продаж
Поисковые запросы по вашим товарам
История остатков
Аналитика продавца CSV
Отчёт об остатках на складах
Отчёт о товарах с обязательной маркировкой
Отчёты об удержаниях
Платная приёмка
Платное хранение
Продажи по регионам
Доля бренда в продажах
Скрытые товары
Отчёт о возвратах и перемещении товаров
Цены и скидки Цены и скидки
Календарь акций
Маркетплейс Заказы FBS
Склады продавца
Остатки
Заказы DBS
Самовывоз
Статистика Основные отчёты
Финансовые отчёты
Продвижение Кампании
Создание кампаний
Управление кампаниями
Параметры кампаний
Финансы
Медиа
Статистика
Вопросы и отзывы Вопросы
Отзывы
Шаблоны ответов
Чат с покупателями Чат с покупателями
Поставки Поставки FBW
Возвраты Возвраты покупателями
Документы Документы
Финансы Баланс
Выбирайте только те категории, с которыми вы планируете работать. Например, если вы будете только загружать карточки товаров, выберите одну категорию — Контент. Если токен попадёт в чужие руки, по нему нельзя будет получить доступ к другим категориям API вашего магазина.
  1. Добавьте комментарий к токену по желанию. Для персонального токена отметьте чекбокс Я понимаю, что не следует передавать токен третьим лицам.
  2. Нажмите Создать. Появится окно с вашим токеном.
  3. Нажмите кнопку Скопировать и закрыть — окно закроется, токен будет скопирован в буфер обмена. После этого токен нельзя будет посмотреть в личном кабинете.
  4. Сохраните токен в безопасном месте. Если вы потеряли токен, создайте новый.
Если у вас несколько сервисов (интеграций) для работы с разными категориями, создайте для них отдельные токены. Это позволит предоставить доступ только к необходимым категориям, а также более гибко и безопасно управлять интеграциями.

Как устроен токен

Токен представляет собой JWT согласно RFC 7519. Чтобы проверить, действителен ли ваш токен и какие категории методов API по нему доступны, вы можете декодировать его.

Рекомендуем не просматривать токен с помощью внешних онлайн-инструментов, чтобы он не попал в чужие руки

Поля токенов

Тип токена можно определить по списку полей из payload токена после декодирования:

Токен Значение acc Значение for Значение t
Базовый токен 1 Поле отсутствует false
Тестовый токен 2 Поле отсутствует true
Персональный токен 3 self false
Сервисный токен 4 asid:{ID сервиса} false

Другие поля:

Поле Тип Описание
id UUIDv4 Уникальный ID токена
s uint Битовая маска свойств токена
sid UUIDv4 Уникальный ID продавца на Wildberries, которому принадлежит токен
exp uint Время жизни токена. Соответствует стандарту RFC 7519: JSON Web Token (JWT)

Остальные поля payload служебные и могут быть удалены.

Поле s

Поле s — это битовая маска, то есть целое число, каждый бит которого означает наличие или отсутствие какого-то свойства.

Подробнее про битовую маску

Значения бит

Позиция бита отсчитывается от 0, где 0 — это младший бит.

Позиция бита Свойство (если бит равен 1)
1 Доступ к категории Контент
2 Доступ к категории Аналитика
3 Доступ к категории Цены и скидки
4 Доступ к категории Маркетплейс
5 Доступ к категории Статистика
6 Доступ к категории Продвижение
7 Доступ к категории Вопросы и отзывы
9 Доступ к категории Чат с покупателями
10 Доступ к категории Поставки
11 Доступ к категории Возвраты покупателями
12 Доступ к категории Документы
13 Доступ к категории Финансы
30 Токен только на чтение

Декодирование токена

Декодирование токена позволяет проверить, является ли токен действительным и к каким категориям методов API имеется доступ. Вы можете декодировать токен на отдельной странице портала разработчиков.

Проверка подключения к WB API

Проверить подключение можно с токеном любой категории

Проверка подключения{{ /ping }}

Описание метода

Метод проверяет:

  1. Успешно ли запрос доходит до WB API
  2. Валидность токена авторизации и URL запроса
  3. Совпадают ли категория токена и сервис
Метод не предназначен для проверки доступности сервисов WB

У каждого сервиса есть свой вариант метода в зависимости от домена:

Категория URL запроса
Контент https://content-api.wildberries.ru/ping
https://content-api-sandbox.wildberries.ru/ping
Аналитика https://seller-analytics-api.wildberries.ru/ping
Цены и скидки https://discounts-prices-api.wildberries.ru/ping
https://discounts-prices-api-sandbox.wildberries.ru/ping
Маркетплейс https://marketplace-api.wildberries.ru/ping
Статистика https://statistics-api.wildberries.ru/ping
https://statistics-api-sandbox.wildberries.ru/ping
Продвижение https://advert-api.wildberries.ru/ping
https://advert-api-sandbox.wildberries.ru/ping
Вопросы и отзывы https://feedbacks-api.wildberries.ru/ping
https://feedbacks-api-sandbox.wildberries.ru/ping
Чат с покупателями https://buyer-chat-api.wildberries.ru/ping
Поставки https://supplies-api.wildberries.ru/ping
Возвраты покупателями https://returns-api.wildberries.ru/ping
Документы https://documents-api.wildberries.ru/ping
Финансы https://finance-api.wildberries.ru/ping
Тарифы, Новости, Информация о продавце https://common-api.wildberries.ru/ping
Максимум 3 запроса за 30 секунд. Если попытаться автоматизировать использование метода, запросы будут временно заблокированы. Лимит действует отдельно для каждого варианта метода в зависимости от домена
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "TS": "2024-08-16T11:19:05+03:00",
  • "Status": "OK"
}

API новостей

Новости портала продавцов можно получить с токеном любой категории

Получение новостей портала продавцов{{ /api/communications/v2/news }}

Описание метода

Метод позволяет получать новости портала продавцов.
Для получения успешного ответа необходимо указать один из параметров from или fromID.
За один запрос можно получить не более 100 новостей.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 10 запросов
Authorizations:
HeaderApiKey
query Parameters
from
string <date>
Example: from=2025-02-06

Дата, от которой необходимо выдать новости

fromID
integer <uint64>
Example: fromID=7369

ID новости, начиная с которой — включая её — нужно получить список новостей

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Информация о продавце

Информацию о продавце можно получить с токеном любой категории

Получение информации о продавце{{ /api/v1/seller-info }}

Описание метода

Метод позволяет получать наименование продавца и ID его аккаунта.
В запросе можно использовать любой токен, у которого не выбрана опция Тестовый контур.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 10 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "name": "ИП Кружинин В. Р.",
  • "sid": "e8923014-e233-47q8-898e-3cc86d67ea61",
  • "tradeMark": "Flax Store"
}
Документация — WB API
Поиск

Общее (general)

В этом разделе:

С помощью методов этого раздела вы можете:

Общее

В этом разделе:

С помощью методов этого раздела вы можете:

Введение

Wildberries API предоставляет продавцам инструменты для управления магазином и получения оперативной и статистической информации по протоколу HTTP REST API.

Главное преимущество API — возможность автоматизировать процессы за счет интеграции с информационными системами продавца: например, ERP, WMS, OMS, CRM. С WB API продавец может не управлять магазином через интерфейс сайта вручную.

Использование API для работы с магазином на Wildberries — это отличный способ:

  • автоматизировать рутинные процессы
  • получить доступ к актуальной информации
  • оптимизировать управление ассортиментом

Документация API предоставлена в формате Swagger OpenAPI и может быть использована для импорта в другие инструменты — например, Postman — или генерации клиентского кода на различных языках программирования с помощью Swagger CodeGen.

Для ручного тестирования API вы можете использовать:

  • Под ОС Windows — PostMan
  • Под ОС Linux — curl

Как начать работу с API

  1. Зарегистрируйтесь в личном кабинете Продавца.
  2. Перейдите в настройки магазина и создайте API-токен. Токен позволит получить доступ к WB API. Система токенов позволит вам контролировать, кто и как взаимодействует с вашими данными через API.
  3. Разработайте интеграцию с API с помощью собственных разработчиков или внешних специалистов. Вы также можете подключить партнёрские сервисы из нашего каталога решений для бизнеса.
Используйте метод проверки подключения, чтобы узнать, успешно ли доходят запросы до API и правильно ли настроен API-токен.

Практические советы:

  • Используйте документацию.
    Официальная документация WB API поможет разобраться в функциональности и возможностях API. В ней приводятся примеры возможных запросов и ответов, список возможных ошибок, лимиты запросов, правила безопасности и так далее.
  • Регулярно проверяйте работу интеграции.
    Следите, корректно ли вы передаете данные и какие вы получаете ответы, чтобы вовремя дорабатывать интеграцию. Не забывайте про ограничения и учитывайте лимиты на количество запросов.
  • Храните API-токен в безопасности.
    Не передавайте его третьим лицам без необходимости. Используйте только доверенные сервисы. При обнаружении подозрительной активности немедленно удалите и замените токен.
  • При необходимости обращайтесь в техническую поддержку.
  • Следите за новостями и изменениями WB API в:

Поддержка

Техническая поддержка происходит через диалоги в личном кабинете продавца. При создании нового обращения в техподдержку используйте категорию API.

Статус-коды HTTP

Основные статус-коды ответов на запросы в WB API:

Код Описание Как решить
200 Успешно
204 Удалено/Обновлено/Добавлено
400 Неправильный запрос Проверьте синтаксис запроса
401 Пользователь не авторизован Проверьте токен авторизации. Категория токена должна совпадать с категорией API. Также токен может:
• быть просрочен
• быть некорректным
• отсутствовать в запросе
403 Доступ запрещён Токен не должен быть сгенерирован удалённым пользователем. Доступ к методу не должен быть заблокирован. Если вы хотите использовать методы Джема, проверьте подписку в личном кабинете
404 Не найдено Проверьте URL запроса
409 Ошибка сохранения для части ссылок/обновления статуса/добавления сборочного задания/т.д. Проверьте данные запроса. Они должны отвечать требованиям и ограничениям сервиса
413 Превышен лимит объёма данных в запросе Уменьшите количество объектов в запросе
422 Отсутствие в запросе параметра nmId/Размер ставки не изменен/т.д. Проверьте данные запроса. Данные запроса не должны противоречить друг другу
429 Слишком много запросов Проверьте лимиты запросов и повторите запрос позже
5ХХ Внутренние ошибки сервиса Сервис недоступен. Повторите запрос позже или обратитесь в техническую поддержку
Обращайте внимание на поле details в ошибках 404 и 429 — туда мы добавляем полезную информацию по использованию методов

Пример ошибки:

{
  "title": "path not found",
  "detail": "Please consult the https://dev.wildberries.ru/openapi/api-information",
  ...
  "status": 404,
  "statusText": "Not Found",
  "timestamp": "2025-04-24T07:25:28Z"
}

Лимиты запросов

В WB API есть ограничения на скорость отправки запросов. Для равномерного распределения нагрузки используется алгоритм token bucket. Лимиты для конкретных методов API указаны в документации.

Например:

Лимит запросов на один аккаунт продавца для всех методов категории Маркетплейс:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

  • Период — временной интервал, в течение которого можно отправить максимальное количество запросов по лимиту.
  • Лимит — максимальное количество запросов за период. В примере за одну минуту можно отправить до 300 запросов. Запросы должны быть равномерно распределены по времени.
  • Интервал — промежуток времени для пауз между запросами. В примере должен составлять 60 секунд/300 запросов200 миллисекунд или 0.2 секунды. Используйте интервал, чтобы равномерно распределить отправку запросов.
  • Всплескburst, максимальное количество запросов, которое можно отправить одновременно, без интервальных пауз. Допустимый всплеск также возвращается в ответе в заголовке X-Ratelimit-Remaining. Он встречается во всех статусах ответов, кроме ошибки 429.

X-Ratelimit-Remaining — это количество запросов, которое можно выполнить на данный момент без пауз. Значение X-Ratelimit-Remaining уменьшается на единицу после каждого запроса. Если X-Ratelimit-Remaining равен 0 и вы сделали следующий запрос без задержки, в ответ вы получите ошибку 429. Значение X-Ratelimit-Remaining восстанавливается со временем.

Есть случаи, когда один запрос может быть равен нескольким. Например, если вы отправляете запросы категории Маркетплейс, запрос с ошибкой 409 будет равен 10 запросам с другими статусами. Тогда значение X-Ratelimit-Remaining снизится сразу на 10 единиц.

Если вы превысите скорость выполнения запросов, вы получите ошибку 429. В этом случае следующий запрос вы сможете сделать только после небольшого ожидания. Чтобы понять, сколько времени вам нужно ждать, используйте заголовки ответа 429:

  • X-Ratelimit-Retry — через сколько секунд вы можете повторить запрос. Если вы сделаете попытку раньше, вы все равно будете получать ошибку 429.
  • X-Ratelimit-Limit — максимальное значение всплеска запросов — burst, которое будет восстановлено через X-Ratelimit-Reset секунд.
  • X-Ratelimit-Reset — через сколько секунд допустимый всплеск запросов восстановится до максимального значения, указанного в X-Ratelimit-Limit.

Пример ответа:

HTTP/1.1 429 Too Many Requests
...
X-Ratelimit-Reset: 29
X-Ratelimit-Retry: 2
...
X-Ratelimit-Limit: 10

Авторизация

Чтобы авторизоваться в API, вам понадобится токен. Он действует 180 дней после создания. Добавляйте токен в заголовок запроса Authorization.

По пункту 9.9.6 оферты запрещена интеграция с порталом продавца без WB API

Правила использования токенов доступа к API

Подробнее о токенах можно узнать в инструкции в справочном центре

Для авторизации доступно четыре типа токенов:

Персональный токен

  • Назначение: Эксклюзивный токен с расширенными возможностями. Предназначен для того, чтобы предоставлять доступ к данным продавца только вашим собственным программам — в том числе корпоративным системам (on-premise), развёрнутым на собственной или арендованной инфраструктуре.
    Расширенные возможности означают, что со временем по персональному токену появится доступ к дополнительным категориям данных продавца, которые недоступны в базовом токене. Мы заранее расскажем об этом в новостях.
  • Подходит для:
    • собственных программных продуктов или систем компании, размещённых на своих или арендованных серверах
    • готовых ERP/CRM-систем в редакции on-premise, включая локальные (коробочные) версии 1С, развёрнутые на серверах компании или на компьютерах пользователей
  • Ограничения: Персональный токен даёт доступ к чувствительной информации, поэтому его нельзя передавать третьим лицам или использовать в облачных сервисах. При создании токена система покажет предупреждение об ответственности — его нужно принять, чтобы продолжить.
    Настройки токена вы выбираете самостоятельно. Если не уверены, какие параметры указать, уточните у разработчика или IT-специалиста, который отвечает за подключаемую систему.

Сервисный токен

  • Назначение: Специальный токен для подключения конкретного облачного сервиса из официального Каталога готовых решений для бизнеса на Wildberries.
  • Особенности: При создании токена вы выбираете сервис из Каталога, после чего все необходимые настройки, в том числе категории данных и уровни доступа, заполняются автоматически. Вам останется только подтвердить создание токена и передать его сервису.
  • Ограничения: Привязан к конкретному сервису и работает только с ним.

Базовый токен

  • Назначение: Вспомогательный токен, который предоставляет доступ к ограниченному набору данных продавца и используется во всех случаях, когда не подходит сервисный или персональный токен.
  • Подходит для:
    • тестирования интеграции на реальных данных перед запуском
    • остальных случаев, когда вы не можете использовать сервисный или персональный токен
  • Ограничения: Можно работать с ограниченным набором данных.

Тестовый токен

  • Назначение: Специальный токен для безопасного тестирования и отладки интеграций в изолированной среде — песочнице WB API.
  • Подходит для:
    • разработки и отладки интеграций без риска для реальных данных
    • изучения возможностей API и экспериментов с методами
    • проверки новых функций перед запуском в рабочей среде
  • Ограничения: Тестовый токен работает только с песочницей и даёт доступ к сгенерированным тестовым данным. Реальные данные магазина при этом недоступны. |

Как создать персональный, базовый или тестовый токен

Подробнее о создании Сервисного токена можно узнать в инструкции в справочном центре
  1. В личном кабинете перейдите в раздел Интеграции по API.
  2. Нажмите + Создать токен. Откроется окно создания токена с двумя вкладками. Для всех типов токенов, кроме сервисного, выберите вкладку Для интеграции вручную.
  3. Выберите тип токена.
  4. Для базового и персонального токенов:
  • Заполните название токена
  • Выберите, с какими категориями API вы будете работать
  • Задайте уровень доступа к данным: Чтение и запись или Только чтение
Категория Методы
Контент Категории, предметы и характеристики
Создание карточек товаров
Карточки товаров
Медиафайлы
Ярлыки
Аналитика Воронка продаж
Поисковые запросы по вашим товарам
История остатков
Аналитика продавца CSV
Отчёт об остатках на складах
Отчёт о товарах с обязательной маркировкой
Отчёты об удержаниях
Платная приёмка
Платное хранение
Продажи по регионам
Доля бренда в продажах
Скрытые товары
Отчёт о возвратах и перемещении товаров
Цены и скидки Цены и скидки
Календарь акций
Маркетплейс Заказы FBS
Склады продавца
Остатки
Заказы DBS
Самовывоз
Статистика Основные отчёты
Финансовые отчёты
Продвижение Кампании
Создание кампаний
Управление кампаниями
Параметры кампаний
Финансы
Медиа
Статистика
Вопросы и отзывы Вопросы
Отзывы
Шаблоны ответов
Чат с покупателями Чат с покупателями
Поставки Поставки FBW
Возвраты Возвраты покупателями
Документы Документы
Финансы Баланс
Выбирайте только те категории, с которыми вы планируете работать. Например, если вы будете только загружать карточки товаров, выберите одну категорию — Контент. Если токен попадёт в чужие руки, по нему нельзя будет получить доступ к другим категориям API вашего магазина.
  1. Добавьте комментарий к токену по желанию. Для персонального токена отметьте чекбокс Я понимаю, что не следует передавать токен третьим лицам.
  2. Нажмите Создать. Появится окно с вашим токеном.
  3. Нажмите кнопку Скопировать и закрыть — окно закроется, токен будет скопирован в буфер обмена. После этого токен нельзя будет посмотреть в личном кабинете.
  4. Сохраните токен в безопасном месте. Если вы потеряли токен, создайте новый.
Если у вас несколько сервисов (интеграций) для работы с разными категориями, создайте для них отдельные токены. Это позволит предоставить доступ только к необходимым категориям, а также более гибко и безопасно управлять интеграциями.

Как устроен токен

Токен представляет собой JWT согласно RFC 7519. Чтобы проверить, действителен ли ваш токен и какие категории методов API по нему доступны, вы можете декодировать его.

Рекомендуем не просматривать токен с помощью внешних онлайн-инструментов, чтобы он не попал в чужие руки

Поля токенов

Тип токена можно определить по списку полей из payload токена после декодирования:

Токен Значение acc Значение for Значение t
Базовый токен 1 Поле отсутствует false
Тестовый токен 2 Поле отсутствует true
Персональный токен 3 self false
Сервисный токен 4 asid:{ID сервиса} false

Другие поля:

Поле Тип Описание
id UUIDv4 Уникальный ID токена
s uint Битовая маска свойств токена
sid UUIDv4 Уникальный ID продавца на Wildberries, которому принадлежит токен
exp uint Время жизни токена. Соответствует стандарту RFC 7519: JSON Web Token (JWT)

Остальные поля payload служебные и могут быть удалены.

Поле s

Поле s — это битовая маска, то есть целое число, каждый бит которого означает наличие или отсутствие какого-то свойства.

Подробнее про битовую маску

Значения бит

Позиция бита отсчитывается от 0, где 0 — это младший бит.

Позиция бита Свойство (если бит равен 1)
1 Доступ к категории Контент
2 Доступ к категории Аналитика
3 Доступ к категории Цены и скидки
4 Доступ к категории Маркетплейс
5 Доступ к категории Статистика
6 Доступ к категории Продвижение
7 Доступ к категории Вопросы и отзывы
9 Доступ к категории Чат с покупателями
10 Доступ к категории Поставки
11 Доступ к категории Возвраты покупателями
12 Доступ к категории Документы
13 Доступ к категории Финансы
30 Токен только на чтение

Декодирование токена

Декодирование токена позволяет проверить, является ли токен действительным и к каким категориям методов API имеется доступ. Вы можете декодировать токен на отдельной странице портала разработчиков.

Проверка подключения к WB API

Проверить подключение можно с токеном любой категории

Проверка подключения{{ /ping }}

Описание метода

Метод проверяет:

  1. Успешно ли запрос доходит до WB API
  2. Валидность токена авторизации и URL запроса
  3. Совпадают ли категория токена и сервис
Метод не предназначен для проверки доступности сервисов WB

У каждого сервиса есть свой вариант метода в зависимости от домена:

Категория URL запроса
Контент https://content-api.wildberries.ru/ping
https://content-api-sandbox.wildberries.ru/ping
Аналитика https://seller-analytics-api.wildberries.ru/ping
Цены и скидки https://discounts-prices-api.wildberries.ru/ping
https://discounts-prices-api-sandbox.wildberries.ru/ping
Маркетплейс https://marketplace-api.wildberries.ru/ping
Статистика https://statistics-api.wildberries.ru/ping
https://statistics-api-sandbox.wildberries.ru/ping
Продвижение https://advert-api.wildberries.ru/ping
https://advert-api-sandbox.wildberries.ru/ping
Вопросы и отзывы https://feedbacks-api.wildberries.ru/ping
https://feedbacks-api-sandbox.wildberries.ru/ping
Чат с покупателями https://buyer-chat-api.wildberries.ru/ping
Поставки https://supplies-api.wildberries.ru/ping
Возвраты покупателями https://returns-api.wildberries.ru/ping
Документы https://documents-api.wildberries.ru/ping
Финансы https://finance-api.wildberries.ru/ping
Тарифы, Новости, Информация о продавце https://common-api.wildberries.ru/ping
Максимум 3 запроса за 30 секунд. Если попытаться автоматизировать использование метода, запросы будут временно заблокированы. Лимит действует отдельно для каждого варианта метода в зависимости от домена
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "TS": "2024-08-16T11:19:05+03:00",
  • "Status": "OK"
}

API новостей

Новости портала продавцов можно получить с токеном любой категории

Получение новостей портала продавцов{{ /api/communications/v2/news }}

Описание метода

Метод позволяет получать новости портала продавцов.
Для получения успешного ответа необходимо указать один из параметров from или fromID.
За один запрос можно получить не более 100 новостей.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 10 запросов
Authorizations:
HeaderApiKey
query Parameters
from
string <date>
Example: from=2025-02-06

Дата, от которой необходимо выдать новости

fromID
integer <uint64>
Example: fromID=7369

ID новости, начиная с которой — включая её — нужно получить список новостей

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Информация о продавце

Информацию о продавце можно получить с токеном любой категории

Получение информации о продавце{{ /api/v1/seller-info }}

Описание метода

Метод позволяет получать наименование продавца и ID его аккаунта.
В запросе можно использовать любой токен, у которого не выбрана опция Тестовый контур.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 10 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "name": "ИП Кружинин В. Р.",
  • "sid": "e8923014-e233-47q8-898e-3cc86d67ea61",
  • "tradeMark": "Flax Store"
}
Документация — WB API
Поиск

Работа с товарами (products)

С помощью методов этого раздела вы можете:

Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами

Работа с товарами

С помощью методов этого раздела вы можете:

Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами

Категории, предметы и характеристики

Для доступа к методам используйте токен для категории Контент
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами
Узнать больше о категориях, предметах и характеристиках можно в справочном центре

Для создания карточек товаров необходимо:

  1. Определить родительскую категорию, к которой будет относиться товар.
  2. Внутри категории выбрать предмет.
  3. Подобрать для каждого предмета характеристики товара. Характеристики Цвет, Пол, Страна производства, Сезон, Ставка НДС и ТНВЭД-код можно получить с помощью отдельных методов.

Родительские категории товаров{{ /content/v2/object/parent/all }}

Описание метода

Метод возвращает названия и ID всех родительских категорий для создания карточек товаров: например, Электроника, Бытовая химия, Рукоделие.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Язык поля ответа name:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Список предметов{{ /content/v2/object/all }}

Описание метода

Метод возвращает список названий родительских категорий предметов и их предметов с ID. Например, у категории Игрушки будут предметы Калейдоскопы, Куклы, Мячики.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Язык полей ответа:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

name
string
Example: name=Носки

Поиск по названию предмета (Носки), поиск работает по подстроке, искать можно на любом из поддерживаемых языков

limit
integer
Default: 30
Example: limit=1000

Количество предметов, максимум 1000

offset
integer
Default: 0
Example: offset=5000

Сколько элементов пропустить. Например, для значения 10 ответ начнется с 11 элемента

parentID
integer
Example: parentID=1000

ID родительской категории предмета

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Характеристики предмета{{ /content/v2/object/charcs/{subjectId} }}

Описание метода

Метод возвращает параметры характеристик предмета: названия, типы данных, единицы измерения и так далее. В запросе необходимо указать ID предмета.

Для получения значений характеристик Цвет, Пол, Страна производства, Сезон, Ставка НДС и ТНВЭД-код используйте отдельные методы
Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
path Parameters
subjectId
required
integer
Example: 105

ID предмета

query Parameters
locale
string
Example: locale=en

Язык полей ответа subjectName и name:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Цвет{{ /content/v2/directory/colors }}

Описание метода

Метод возвращает возможные значения характеристики предмета Цвет.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Язык полей ответа subjectName и name:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Пол{{ /content/v2/directory/kinds }}

Описание метода

Метод возвращает возможные значения характеристики предмета Пол.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Язык полей ответа subjectName и name:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Страна производства{{ /content/v2/directory/countries }}

Описание метода

Метод возвращает возможные значения характеристики предмета Страна производства.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Язык полей ответа subjectName и name:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Сезон{{ /content/v2/directory/seasons }}

Описание метода

Метод возвращает возможные значения характеристики предмета Сезон.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Язык полей ответа subjectName и name:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Ставка НДС{{ /content/v2/directory/vat }}

Описание метода

Метод возвращает возможные значения характеристики предмета Ставка НДС.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=ru

Язык полей ответа subjectName и name:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

ТНВЭД-код{{ /content/v2/directory/tnved }}

Описание метода

Метод возвращает список ТНВЭД-кодов по ID предмета и фрагменту ТНВЭД-кода.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
subjectID
required
integer
Example: subjectID=105

ID предмета

search
integer
Example: search=6106903000

Поиск по ТНВЭД-коду. Работает только в паре с subjectID

locale
string
Example: locale=en

Язык полей ответа:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Создание карточек товаров

Для доступа к методам используйте токен для категории Контент
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами
Узнать больше о создании карточек товаров можно в справочном центре

После получения категорий, предметов и характеристик товаров вы можете создать карточку товара. Для этого:

  1. Проверьте лимиты для создания карточек товаров.
  2. Вы можете сгенерировать баркоды для карточек товаров. Но если вы создадите карточку товара без баркода, он будет сгенерирован автоматически. Либо вы можете использовать свой баркод.

Можно создавать карточки товаров:

  1. Объединёнными или необъединёнными.
  2. Присоединёнными к уже существующим карточкам товаров.

Объединять и разъединять карточки товаров можно через imtID — ID карточки в WB для объединения.

Лимиты карточек товаров{{ /content/v2/cards/limits }}

Описание метода

Возвращает бесплатные и платные лимиты продавца на создание карточек товаров.

Формула для получения количества карточек, которые можно создать:

(freeLimits + paidLimits) - количество созданных карточек

Созданными считаются карточки, которые можно получить через методы список карточек товаров и список карточек товаров в корзине.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Генерация баркодов{{ /content/v2/barcodes }}

Описание метода

Метод генерирует массив уникальных баркодов для создания размера в карточке товара. Можно использовать, если у вас нет собственных баркодов.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
count
integer

Кол-во баркодов которые надо сгенерировать, максимальное доступное количество баркодов для генерации - 5 000

Responses

Request samples

Content type
application/json
{
  • "count": 100
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Создание карточек товаров{{ /content/v2/cards/upload }}

Описание метода

Метод создаёт карточки товаров c указанием описаний и характеристик товаров.

Есть две формы запроса: для создания отдельных и объединённых карточек товаров.

Габариты товаров можно указать только в сантиметрах, вес товара с упаковкой — в килограммах.

Создание карточки товара происходит асинхронно. После отправки запрос становится в очередь на обработку.
В одном запросе можно создать максимум 100 объединённых карточек товаров (imtID), по 30 карточек товаров в каждой. Максимальный размер запроса 10 Мб.
Если ответ Успешно (200), но какие-то карточки не создались, проверьте список несозданных карточек товаров.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 10 запросов 6 секунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
Array
subjectID
required
integer

ID предмета

required
Array of objects

Массив вариантов товара.
В каждой объединённой карточке товара может быть не более 30 карточек товаров

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Создание карточек товаров с присоединением{{ /content/v2/cards/upload/add }}

Описание метода

Метод создаёт новые карточки товаров, присоединяя их к существующим карточкам.

Габариты товаров можно указать только в сантиметрах, вес товара с упаковкой — в килограммах.

Создание карточки товара происходит асинхронно. После отправки запрос становится в очередь на обработку.
Максимальный размер запроса 10 Мб.
Если ответ Успешно (200), но какие-то карточки не создались, проверьте список несозданных карточек товаров.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 10 запросов 6 секунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
imtID
integer

imtID карточки товара, к которой присоединяется карточка товара

Array of objects

Структура присоединяемой карточки товара

Responses

Request samples

Content type
application/json
{
  • "imtID": 987654321,
  • "cardsToAdd": [
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Карточки товаров

Для доступа к методам используйте токен для категории Контент
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами
Узнать больше о карточках товаров можно в справочном центре

После создания карточек товаров вы можете:

  1. Получать списки с подробной информацией об уже созданных карточках. Если вы не увидели карточку товара в списке после её создания, произошла ошибка.
  2. Объединять и разъединять созданные карточки.
  3. Редактировать данные карточки товара.
  4. Работать с корзиной: можно переносить карточки товаров в корзину и восстанавливать их.
  5. Получать списки карточек товаров в корзине.

Список карточек товаров{{ /content/v2/get/cards/list }}

Описание метода
Метод доступен по токену с категорией Контент или Продвижение

Метод возвращает список созданных карточек товаров.

В ответе метода не будет карточек, находящихся в корзине. Получить такие карточки можно через отдельный метод.

Чтобы получить больше 100 карточек товаров, используйте пагинацию:

  1. Сделайте первый запрос:
       {
         "settings": {
           "cursor": {
             "limit": 100
           },
           "filter": {
             "withPhoto": -1
           }
         }
       }
  2. Скопируйте "updatedAt": "***", "nmID": *** из cursor ответа и вставьте в cursor запроса.
  3. Повторите запрос.
  4. Повторяйте пункты 2 и 3, пока значение total в ответе не станет меньше чем значение limit в запросе. Это будет означать, что вы получили все карточки.
Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=ru

Язык полей ответа name, value и object:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Request Body schema: application/json
required
object

Настройки

Responses

Request samples

Content type
application/json
{
  • "settings": {
    }
}

Response samples

Content type
application/json
{}

Список несозданных карточек товаров с ошибками{{ /content/v2/cards/error/list }}

Описание метода

Метод возвращает список карточек товаров (черновиков), при создании или редактировании которых произошли ошибки, с описанием этих ошибок.

Данные в ответе возвращаются пакетами batch. Один пакет содержит:

  1. Сделайте первый запрос:
       {
         "cursor": {
           "limit": 100
         },
         "order": {
           "ascending": true
         }
       }
  2. Скопируйте "updatedAt": "***","batchUUID": "***" из cursor ответа и вставьте в cursor запроса.
  3. Повторите запрос.
  4. Повторяйте пункты 2 и 3, пока не получите в ответе "next": false. Это будет означать, что вы получили все пакеты.
Чтобы удалить карточку товара из списка, сделайте ещё один запрос на создание, создание с присоединением или редактирование карточки товара с исправленными ошибками
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 10 запросов 6 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Язык названий предметов:

  • ru — русский
  • en — английский
  • zh — китайский
Request Body schema: application/json
required
object (swagger.PublicErrorsCursorInput)

Пагинатор

object (swagger.PublicErrorsOrderV2)

Порядок выдачи пакетов

Responses

Request samples

Content type
application/json
{
  • "cursor": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Редактирование карточек товаров{{ /content/v2/cards/update }}

Описание метода

Метод обновляет карточки товаров. Данные для обновления можно получить через список карточек товаров и список карточек товаров в корзине.

Карточка товара перезаписывается при обновлении. Поэтому в запросе нужно передать все параметры карточки, в том числе те, которые вы не собираетесь обновлять.

Нельзя редактировать или удалять баркоды, но можно добавить дополнительный баркод к карточке товара. Параметры photos, video и tags редактировать или удалять через данный метод нельзя.
Габариты товаров можно указать только в сантиметрах, вес товара с упаковкой — в килограммах.

В одном запросе можно отредактировать максимум 3000 карточек товаров (nmID). Максимальный размер запроса 10 Мб.
Если ответ Успешно (200), но какие-то карточки не обновились, проверьте список несозданных карточек товаров.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 10 запросов 6 секунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
Array
nmID
required
integer

Артикул WB

vendorCode
required
string

Артикул продавца

brand
string

Бренд

title
string <= 60 characters

Наименование товара

description
string

Описание товара
Максимальное количество символов зависит от категории товара
Стандарт — 2000, минимум — 1000, максимум — 5000
Подробно о правилах описания в Правилах заполнения карточки товара в Справочном центре на портале продавцов

object

Габариты и вес товара c упаковкой.
Укажите в сантиметрах и килограммах для любого товара

Array of objects

Характеристики товара.
Можно получить методом Характеристики предмета

required
Array of objects

Массив размеров
Для безразмерного товара всё равно нужно передавать данный массив без параметров (wbSize и techSize), но с баркодом

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Объединение и разъединение карточек товаров{{ /content/v2/cards/moveNm }}

Описание метода

Метод объединяет и разъединяет карточки товаров. Карточки товаров считаются объединёнными, если у них одинаковый imtID.

Для объединения карточек товаров сделайте запрос с указанием imtID. Можно объединять не более 30 карточек товаров.
Для разъединения карточек товаров сделайте запрос без указания imtID. Для разъединенных карточек будут сгенерированы новые imtID.

Если вы разъедините одновременно несколько карточек товаров, эти карточки объединятся в одну и получат новый imtID.
Чтобы присвоить каждой карточке товара уникальный imtID, необходимо передавать по одной карточке товара за запрос.

Максимальный размер запроса 10 Мб.

Объединить можно только карточки товаров с одинаковыми предметами.
Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
Request Body schema: application/json
One of
targetIMT
required
integer

Существующий у продавца imtID, под которым необходимо объединить карточки товаров

nmIDs
required
Array of integers

nmID, которые необходимо объединить (максимум 30)

Responses

Request samples

Content type
application/json
Example
{
  • "targetIMT": 123,
  • "nmIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Перенос карточек товаров в корзину{{ /content/v2/cards/delete/trash }}

Описание метода

Метод переносит карточки товаров в корзину. При этом карточки товаров не удаляются, их можно восстановить.

После переноса в корзину карточке товара присваивается новый imtID.

Карточки товаров удаляются автоматически, если лежат в корзине больше 30 дней. Очистка корзины происходит каждую ночь по московскому времени.
Карточки товаров можно удалить в любое время в личном кабинете.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers

Артикул WB (max. 1000)

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Восстановление карточек товаров из корзины{{ /content/v2/cards/recover }}

Описание метода

Метод восстанавливает карточки товаров из корзины.

Карточка товара сохраняет тот же imtID, что был присвоен ей при перемещении в корзину.
Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers

Артикул WB (max. 1000)

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Список карточек товаров в корзине{{ /content/v2/get/cards/trash }}

Описание метода
Метод доступен по токену с категорией Контент или Продвижение

Метод возвращает список карточек товаров в корзине.

Чтобы получить больше 100 карточек товаров, используйте пагинацию.

  1. Сделайте первый запрос:
       {
         "settings": {
           "cursor": {
             "limit": 100
           },
           "filter": {
             "withPhoto": -1
           }
         }
       }
  2. Скопируйте "trashedAt": "***", "nmID": *** из cursor ответа и вставьте в cursor запроса.
  3. Повторите запрос.
  4. Повторяйте пункты 2 и 3, пока значение total в ответе не станет меньше чем значение limit в запросе. Это будет означать, что вы получили все карточки.
Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
query Parameters
locale
string
Enum: "ru" "en" "zh"

Язык полей ответа name, value и object:

  • ru — русский
  • en — английский
  • zh — китайский

Не используется в песочнице

Request Body schema: application/json
required
object

Настройки

Responses

Request samples

Content type
application/json
{
  • "settings": {
    }
}

Response samples

Content type
application/json
{}

Медиафайлы

Для доступа к методам используйте токен для категории Контент
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами

Управлять медиафайлами в карточке товара можно двумя способами:

  1. Через прямую загрузку одного медиафайла в карточку товара.
  2. Через перечисление ссылок на медиафайлы. В этом случае новые медиафайлы заменяют медиафайлы, уже добавленные в карточку товара.

Загрузить медиафайл{{ /content/v3/media/file }}

Описание метода

Метод загружает и добавляет один медиафайл к карточке товара.

Требования к изображениям:

  • максимум изображений для одной карточки товара — 30
  • минимальное разрешение — 700x900 px
  • максимальный размер — 32 Мб
  • минимальное качество — 65%
  • форматы — JPG, PNG, BMP, GIF (статичные), WebP

Требования к видео:

  • максимум одно видео для одной карточки товара
  • максимальный размер — 50 Мб
  • форматы — MOV, MP4
Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
header Parameters
X-Nm-Id
required
string
Example: 213864079

Артикул WB

X-Photo-Number
required
integer
Example: 2

Номер медиафайла на загрузку, начинается с 1. При загрузке видео всегда указывайте 1.

Чтобы добавить изображение к уже загруженным, номер медиафайла должен быть больше количества уже загруженных медиафайлов.

Request Body schema: multipart/form-data
required
uploadfile
string <binary>

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Загрузить медиафайлы по ссылкам{{ /content/v3/media/save }}

Описание метода

Метод загружает набор медиафайлов в карточку товара через указание ссылок в запросе.

Новые медиафайлы полностью заменяют старые. Чтобы добавить новые медиафайлы, укажите в запросе ссылки одновременно на новые и старые медиафайлы.

Требования к ссылкам:

  • ссылка должна вести прямо на файл. Убедитесь, что ссылка не ведёт на страницу предпросмотра или авторизации, например. Если по ссылке открывается текстовая страница TXT или HTML, ссылка считается некорректной
  • для доступа к файлу по ссылке не нужна авторизация

Требования к изображениям:

  • максимум изображений для одной карточки товара — 30
  • минимальное разрешение — 700×900 px
  • максимальный размер — 32 Мб
  • минимальное качество — 65%
  • форматы — JPG, PNG, BMP, GIF (статичные), WebP

Требования к видео:

  • максимум одно видео для одной карточки товара
  • максимальный размер — 50 Мб
  • форматы — MOV, MP4

Если видео или хотя бы одно изображение в запросе не соответствует требованиям, то даже при успешном ответе (200) ни одно изображение/видео не загрузится.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmId
integer

Артикул WB

data
Array of strings

Ссылки на изображения в том порядке, в котором они будут в карточке товара, и на видео, на любой позиции массива

Responses

Request samples

Response samples

Content type
application/json
{
  • "data": { },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Ярлыки

Для доступа к методам используйте токен для категории Контент
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами
Узнать больше о ярлыках можно в справочном центре

Ярлыки позволяют быстро фильтровать и искать карточки товаров в личном кабинете. В разделе вам доступны методы:

  1. Получения списка ярлыков продавца. Эти ярлыки можно использовать в карточках товаров.
  2. Добавления новых ярлыков.
  3. Изменения существующих ярлыков.
  4. Удаления ярлыков.
  5. Управления ярлыками в карточке товара: добавления или удаления ярлыка.

Список ярлыков{{ /content/v2/tags }}

Описание метода

Метод возвращает список и характеристики всех ярлыков продавца для группировки и фильтрации товаров.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Создание ярлыка{{ /content/v2/tag }}

Описание метода

Метод добавляет один ярлык продавца. Можно создать максимум 15 ярлыков для одного продавца. Максимальная длина ярлыка — 15 символов.
Созданный ярлык можно получить в общем списке.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
color
string

Цвет ярлыка.

Доступные цвета:

  • D1CFD7 — серый
  • FEE0E0 — красный
  • ECDAFF — фиолетовый
  • E4EAFF — синий
  • DEF1DD — зеленый
  • FFECC7 — желтый
name
string

Имя ярлыка

Responses

Request samples

Content type
application/json
{
  • "color": "D1CFD7",
  • "name": "Sale"
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Изменение ярлыка{{ /content/v2/tag/{id} }}

Описание метода

Метод заменяет данные ярлыка: имя и цвет.
Новые данные можно получить в общем списке.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
path Parameters
id
required
integer
Example: 1

Числовой ID ярлыка

Request Body schema: application/json
required
color
string

Цвет ярлыка

name
string

Имя ярлыка

Responses

Request samples

Content type
application/json
{
  • "color": "D1CFD7",
  • "name": "Sale"
}

Response samples

Content type
application/json

Успешно

{
  • "data": null,
  • "error": true,
  • "errorText": "Неправильный запрос",
  • "additionalErrors": null
}

Удаление ярлыка{{ /content/v2/tag/{id} }}

Описание метода

Метод удаляет ярлык из списка ярлыков продавца.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
path Parameters
id
required
integer
Example: 1

Числовой ID ярлыка

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "error": true,
  • "errorText": "Такого ярлыка не существует",
  • "additionalErrors": null
}

Управление ярлыками в карточке товара{{ /content/v2/tag/nomenclature/link }}

Описание метода

Метод добавляет или снимает ярлык с карточки товара. К карточке можно добавить максимум 15 ярлыков.
При удалении ярлыка из карточки товара он не удаляется из списка ярлыков продавца.

Лимит запросов на один аккаунт продавца для всех методов категории Контент:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 5 запросов

Исключение — методы:

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmID
integer

Артикул WB

tagsIDs
Array of integers

Массив числовых ID ярлыков.
Что бы снять ярлыки с карточки товара, необходимо передать пустой массив.
Чтобы добавить ярлыки к уже имеющимся в карточке товара, необходимо в запросе передать новые ярлыки и ярлыки, которые уже есть в карточке товара.

Responses

Request samples

Content type
application/json
{
  • "nmID": 179891389,
  • "tagsIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Цены и скидки

Для доступа к методам используйте токен для категории Цены и скидки
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами
Узнать больше о ценах и скидках можно в справочном центре

С помощью этих методов можно устанавливать цены и скидки, в том числе цены для размеров одного товара и скидки WB Клуба.

Когда вы обновляете цены или скидки, данные по каким-то товарам могут не обновиться. Например, если вы передали неправильную цену или скидку. Проверяйте статус загрузки с помощью метода состояния обработанной загрузки.

Статусы загрузки:

  • 3 — обработана. В товарах нет ошибок, цены и скидки обновились.
  • 4 — отменена.
  • 5 — обработана, но в товарах есть ошибки. Ошибки можно получить с помощью метода детализации обработанной загрузки. Для товаров без ошибок цены и скидки обновились.
  • 6 — обработана, но во всех товарах есть ошибки. Ошибки можно получить с помощью метода детализации обработанной загрузки.

Если вы задаёте скидки в календаре акций, загрузки попадают в обработку. Скидка применится в момент старта акции. У такой загрузки будет статус 1, получить информацию о ней можно с помощью методов состояния необработанной загрузки и детализации необработанной загрузки.

У загрузки не может быть статуса 2.

Установить цены и скидки{{ /api/v2/upload/task }}

Описание метода

Метод устанавливает цены и скидки для товаров.

Чтобы установить цены для размеров товара, используйте отдельный метод.

Получить информацию о процессе установки цен и скидок можно с помощью методов состояния и детализации обработанной загрузки.
Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (Goods)

Товары, цены и скидки для них. Максимум 1 000 товаров. Цена и скидка не могут быть пустыми одновременно.

Если новая цена со скидкой будет хотя бы в 3 раза меньше старой, она попадёт в карантин и товар будет продаваться по старой цене. Ошибка об этом будет в ответах методов состояний загрузок.

Вы можете изменить цену или скидку с помощью API либо вывести товар из карантина в личном кабинете

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Установить цены для размеров{{ /api/v2/upload/task/size }}

Описание метода

Метод устанавливает цены отдельно для размеров товаров.

Работает только для товаров из категорий, где можно устанавливать цены отдельно для разных размеров. Для таких товаров "editableSizePrice":true.

Чтобы установить цены и скидки для самих товаров, используйте отдельный метод.

Получить информацию о процессе установки цен и скидок можно с помощью методов состояния и детализации обработанной загрузки.
Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (SizeGoodsBody)

Размеры и цены для них. Максимум 1 000 размеров.

Для товаров с поразмерной установкой цен карантин не применяется

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Установить скидки WB Клуба{{ /api/v2/upload/task/club-discount }}

Описание метода

Устанавливает скидки для товаров в рамках подписки WB Клуб.

Получить информацию о процессе установки цен и скидок можно с помощью методов состояния и детализации обработанной загрузки.
Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (ClubDisc)

Товары и скидки WB Клуба для них. Максимум 1 000 товаров.

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Состояние обработанной загрузки{{ /api/v2/history/tasks }}

Описание метода

Метод возвращает информацию об обработанной загрузке цен и скидок.

Обработанная загрузка — это загрузка цен и скидок для товаров, цен для размеров товаров и скидок WB Клуба.
Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
uploadID
required
integer
Example: uploadID=146567

ID загрузки

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Детализация обработанной загрузки{{ /api/v2/history/goods/task }}

Описание метода

Метод возвращает информацию о товарах и об ошибках в товарах в обработанной загрузке.

Обработанная загрузка — это загрузка цен и скидок для товаров, цен для размеров товаров и скидок WB Клуба.
Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint> <= 1000
Example: limit=10

Сколько элементов вывести на одной странице (пагинация)

offset
integer <uint> >= 0
Example: offset=0

Сколько элементов пропустить. Например, для значения 10 ответ начнется с 11 элемента

uploadID
required
integer
Example: uploadID=146567

ID загрузки

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Состояние необработанной загрузки{{ /api/v2/buffer/tasks }}

Описание метода

Метод возвращает информацию про загрузку скидок в обработке.

Необработанная загрузка — это загрузка скидок в календаре акций. Такие скидки применятся к товарам только в момент старта акции.
Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
uploadID
required
integer
Example: uploadID=146567

ID загрузки

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Детализация необработанной загрузки{{ /api/v2/buffer/goods/task }}

Описание метода

Метод возвращает информацию о товарах и ошибках в товарах из загрузки в обработке.

Необработанная загрузка — это загрузка скидок в календаре акций. Такие скидки применятся к товарам только в момент старта акции.
Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint> <= 1000
Example: limit=10

Сколько элементов вывести на одной странице (пагинация)

offset
integer <uint> >= 0
Example: offset=0

Сколько элементов пропустить. Например, для значения 10 ответ начнется с 11 элемента

uploadID
required
integer
Example: uploadID=146567

ID загрузки

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Получить товары с ценами{{ /api/v2/list/goods/filter }}

Описание метода

Метод возвращает информацию о товарах: цены, валюту, общие скидки и скидки WB Клуба.

В одном запросе можно указать только один артикул.

Чтобы получить информацию обо всех товарах продавца, не указывая артикулы, установите limit=1000, в параметре offset установите смещение по количеству записей. Количество нужно рассчитать по формуле: offset плюс limit из предыдущего запроса. Повторяйте запрос, пока вы не получите ответ с пустым массивом.

Используйте отдельные методы, чтобы получить информацию:

Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint> <= 1000
Example: limit=10

Сколько элементов вывести на одной странице (пагинация)

offset
integer <uint> >= 0
Example: offset=0

Сколько элементов пропустить. Например, для значения 10 ответ начнется с 11 элемента

filterNmID
integer
Example: filterNmID=44589768676

Артикул WB для поиска товара

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Получить товары с ценами по артикулам{{ /api/v2/list/goods/filter }}

Описание метода

Метод возвращает информацию о товарах по их артикулам: цены, валюту, общие скидки и скидки WB Клуба.

В одном запросе можно указать более одного артикула.

Используйте отдельные методы, чтобы получить информацию:

Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmList
required
Array of integers [ 1 .. 1000 ] items

Артикулы WB для поиска товара

Responses

Request samples

Content type
application/json
{
  • "nmList": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Получить размеры товара с ценами{{ /api/v2/list/goods/size/nm }}

Описание метода

Метод возвращает информацию обо всех размерах одного товара: цены, валюту, общие скидки и скидки для WB Клуба.

Работает только для товаров из категорий, где можно устанавливать цены отдельно для разных размеров. Для таких товаров "editableSizePrice":true.

Чтобы получить информацию о самом товаре, используйте отдельный метод.

Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint> <= 1000
Example: limit=10

Сколько элементов вывести на одной странице (пагинация)

offset
integer <uint> >= 0
Example: offset=0

Сколько элементов пропустить. Например, для значения 10 ответ начнется с 11 элемента

nmID
required
integer
Example: nmID=1

Артикул WB

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "string"
}

Получить товары в карантине{{ /api/v2/quarantine/goods }}

Описание метода

Метод возвращает информацию о товарах в карантине.

Если новая цена товара со скидкой будет минимум в 3 раза меньше старой, товар попадёт в карантин и будет продаваться по старой цене. Ошибка об этом будет в ответах методов состояний загрузок.

Вы можете изменить цену или скидку с помощью API либо вывести товар из карантина в личном кабинете.

Для товаров с поразмерной установкой цен карантин не применяется.

Лимит запросов на один аккаунт продавца для всех методов категории Цены и скидки:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint> <= 1000
Example: limit=10

Сколько элементов вывести на одной странице (пагинация)

offset
integer <uint> >= 0
Example: offset=0

Сколько элементов пропустить. Например, для значения 10 ответ начнется с 11 элемента

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Склады продавца

Для доступа к методам используйте токен для категории Маркетплейс
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами
Узнать больше о складах продавца можно в справочном центре

На складах продавца доступно управление остатками товаров.

Чтобы работать со складами продавца, вы можете:

  1. Получать список складов WB, если вы работаете по модели FBS (Fulfillment by Seller). Это нужно, чтобы связывать склады WB и склады продавца при создании и редактировании склада.
  2. Получать список складов продавца, если работаете по модели продаж со склада продавца.
  3. Получать и обновлять список контактов складов модели Курьером WB (DBW).
  4. Создавать склады продавца.
  5. Обновлять склады продавца.
  6. Удалять склады продавца.

Получить список складов WB{{ /api/v3/offices }}

Описание метода

Метод возвращает список всех складов WB для привязки к складам продавца. Предназначен для определения складов WB, чтобы сдавать готовые заказы по модели FBS (Fulfillment by Seller).

Лимит запросов на один аккаунт продавца для всех методов складов продавца:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получить список складов продавца{{ /api/v3/warehouses }}

Описание метода

Метод возвращает список всех складов продавца. Может использоваться для получения остатков товаров.

Лимит запросов на один аккаунт продавца для всех методов складов продавца:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Создать склад продавца{{ /api/v3/warehouses }}

Описание метода

Метод создаёт склад продавца для работы с остатками товаров. Нужно привязать к складу продавца склад WB для работы по модели FBS (Fulfillment by Seller).

Нельзя привязывать склад WB, который уже используется
Лимит запросов на один аккаунт продавца для всех методов складов продавца:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Имя склада продавца

officeId
required
integer >= 1

ID склада WB

Responses

Request samples

Content type
application/json
{
  • "name": "Склад Коледино",
  • "officeId": 15
}

Response samples

Content type
application/json
{
  • "id": 2
}

Обновить склад продавца{{ /api/v3/warehouses/{warehouseId} }}

Описание метода

Метод обновляет данные склада продавца в списке складов. Данные о привязанном складе WB можно изменить один раз в сутки.

Нельзя привязывать склад WB, который уже используется
Лимит запросов на один аккаунт продавца для всех методов складов продавца:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Имя склада продавца

officeId
required
integer >= 1

ID склада WB

Responses

Request samples

Content type
application/json
{
  • "name": "Склад Коледино",
  • "officeId": 15
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect required body"
}

Удалить склад продавца{{ /api/v3/warehouses/{warehouseId} }}

Описание метода

Метод удаляет склад продавца из списка складов.

Лимит запросов на один аккаунт продавца для всех методов складов продавца:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Responses

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Список контактов{{ /api/v3/dbw/warehouses/{warehouseId}/contacts }}

Описание метода

Метод возвращает список контактов, привязанных к складу продавца.
Только для складов с типом доставки 3 — доставка курьером WB (DBW).

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Responses

Response samples

Content type
application/json
{
  • "contacts": [
    ]
}

Обновить список контактов{{ /api/v3/dbw/warehouses/{warehouseId}/contacts }}

Описание метода

Метод обновляет список контактов склада продавца.

Список контактов перезаписывается при обновлении. Поэтому в запросе нужно передать все параметры списка контактов, в том числе те, которые вы не собираетесь обновлять.

Только для складов с типом доставки 3 — курьером WB (DBW).

К складу можно добавить максимум 5 контактов. Чтобы удалить контакты, отправьте пустой массив contacts.

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Request Body schema: application/json
required
Array of objects <= 5 items

Responses

Request samples

Content type
application/json
{
  • "contacts": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "IncorrectParameter"
}

Остатки на складах продавца

Для доступа к методам используйте токен для категории Маркетплейс
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами
Узнать больше об остатках на складах продавца можно в справочном центре

Если вы работаете по модели продаж со склада продавца, через эти методы вы можете:

  1. Обновлять остатки товаров.
  2. Удалять остатки. После удаления остатки можно будет загрузить повторно.
  3. Проверять количество остатков.

Обновить остатки товаров{{ /api/v3/stocks/{warehouseId} }}

Описание метода

Метод обновляет количество остатков товаров продавца в списке.

Названия параметров запроса не валидируются. При отправке некорректных названий вы получите успешный ответ (204), но остатки не обновятся.
Лимит запросов на один аккаунт продавца для всех методов остатков на складах продавца:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Request Body schema: application/json
required
Array of objects [ 1 .. 1000 ] items

Массив баркодов товаров и их остатков

Responses

Request samples

Content type
application/json
{
  • "stocks": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect required body"
}

Удалить остатки товаров{{ /api/v3/stocks/{warehouseId} }}

Описание метода

Метод удаляет запись об остатках товаров продавца из списка остатков.

Действие необратимо. Удаленный остаток будет необходимо загрузить повторно для возобновления продаж.
Лимит запросов на один аккаунт продавца для всех методов остатков на складах продавца:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Request Body schema: application/json
required
skus
Array of strings [ 1 .. 1000 ] items

Массив баркодов

Responses

Request samples

Content type
application/json
{
  • "skus": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect required body"
}

Получить остатки товаров{{ /api/v3/stocks/{warehouseId} }}

Описание метода

Метод возвращает данные об остатках товаров на складах продавца.

Лимит запросов на один аккаунт продавца для всех методов остатков на складах продавца:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Request Body schema: application/json
required
skus
required
Array of strings [ 1 .. 1000 ] items

Массив баркодов

Responses

Request samples

Content type
application/json
{
  • "skus": [
    ]
}

Response samples

Content type
application/json
{
  • "stocks": [
    ]
}
Документация — WB API
Поиск

Заказы FBS (order)

Методы для работы со сборочными заданиями модели DBW (Доставка курьером WB) теперь на отдельном контуре.

В разделе заказов FBS (Fulfillment by Seller) вам доступны методы:

  1. Управления сборочными заданиями: информация о сборочных заданиях, метаданные, стикеры и так далее.
  2. Управления поставками заказов продавца на склады WB.
  3. Заказа пропусков на склады WB.
    Узнать больше о заказах FBS можно в справочном центре

Заказы FBS

Методы для работы со сборочными заданиями модели DBW (Доставка курьером WB) теперь на отдельном контуре.

В разделе заказов FBS (Fulfillment by Seller) вам доступны методы:

  1. Управления сборочными заданиями: информация о сборочных заданиях, метаданные, стикеры и так далее.
  2. Управления поставками заказов продавца на склады WB.
  3. Заказа пропусков на склады WB.
    Узнать больше о заказах FBS можно в справочном центре

Сборочные задания FBS

Для доступа к методам используйте токен для категории Маркетплейс
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с заказами FBS
Узнать больше о сборочных заданиях можно в справочном центре

Когда покупатель заказывает товар, у продавца появляется сборочное задание. Сборочное задание всегда содержит 1 единицу товара. Если покупатель закажет 10 единиц одного товара одной корзиной, у продавца появятся 10 сборочных заданий. Их можно сгруппировать по одинаковому orderUid.

Для работы со сборочными заданиями FBS:

  1. Получите новые сборочные задания.
  2. Создайте поставку и добавьте в неё сборочные задания.
  3. Получите стикеры сборочных заданий, распечатайте их и промаркируйте сборочные задания.
  4. Если нужно, добавьте к сборочным заданиям код маркировки, УИН, IMEI, GTIN или срок годности товара.
  5. Если поставка доставляется в пункт выдачи заказов (ПВЗ), переходите к пункту 3 инструкции. Если на склад WB, к пункту 6.
  6. Уточните, требуется ли пропуск на склад, на который поедет поставка. Если нужен, создайте пропуск.

Получить список новых сборочных заданий{{ /api/v3/orders/new }}

Описание метода

Метод возвращает список всех новых сборочных заданий, которые есть у продавца на момент запроса.

Наличие в сборочныx заданияx метаданных, указанных в полях requiredMeta и optionalMeta, влияет только на возможность перевести поставку в доставку. Если ваш товар подлежит обязательной маркировке средствами идентификации, необходимо указывать метаданные независимо от того, в каком поле они были получены (п. 4.6 Оферты).
Рекомендуем добавлять в сборочные задания все метаданные, полученные в полях requiredMeta и optionalMeta
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить информацию о сборочных заданиях{{ /api/v3/orders }}

Описание метода

Метод возвращает информацию о сборочных заданиях без их актуального статуса.

Можно получить данные за заданный период, максимум 30 календарных дней одним запросом.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Параметр пагинации. Устанавливает предельное количество возвращаемых данных.

next
required
integer <int64>

Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноимённого поля в ответе.

dateFrom
integer

Дата начала периода в формате Unix timestamp. По умолчанию — дата за 30 дней до запроса

dateTo
integer

Дата конца периода в формате Unix timestamp

Responses

Response samples

Content type
application/json
{
  • "next": 13833711,
  • "orders": [
    ]
}

Получить статусы сборочных заданий{{ /api/v3/orders/status }}

Описание метода

Метод возвращает статусы сборочных заданий по их ID.

supplierStatus — статус сборочного задания. Триггер его изменения — действие самого продавца.

Возможные значения supplierStatus:

Статус Описание Как перевести сборочное задание в данный статус
new Новое сборочное задание
confirm На сборке Добавить сборочное задание к поставке
complete В доставке Передать поставку в доставку
cancel Отменено продавцом Отменить сборочное задание



wbStatus — статус системы Wildberries.

Возможные значения wbStatus:

  • waiting — сборочное задание в работе
  • sorted — сборочное задание отсортировано
  • sold — заказ получен покупателем
  • canceled — отмена сборочного задания
  • canceled_by_client — покупатель отменил заказ при получении
  • declined_by_client — покупатель отменил заказ. Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборку
  • defect — отмена заказа по причине брака
  • ready_for_pickup — сборочное задание прибыло на пункт выдачи заказов (ПВЗ)
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить все сборочные задания для повторной отгрузки{{ /api/v3/supplies/orders/reshipment }}

Описание метода

Метод возвращает все сборочные задания, требующие повторной отгрузки.

Повторная отгрузка требуется, если поставка была отсканирована в пункте приёмки, но при этом в ней всё ещё есть неотсканированные товары. Спустя определённое время необходимо доставить эти товары заново. Данные сборочные задания можно перевести в другую активную поставку.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Отменить сборочное задание{{ /api/v3/orders/{orderId}/cancel }}

Описание метода

Метод отменяет сборочное задание и переводит в статус cancel — отменено продавцом.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить стикеры сборочных заданий{{ /api/v3/orders/stickers }}

Описание метода

Метод возвращает список стикеров для сборочных заданий.

Можно получить стикер в форматах:

  • SVG
  • ZPLV (вертикальный)
  • ZPLH (горизонтальный)
  • PNG

Ограничения:

  • За один запрос можно получить максимум 100 стикеров.
  • Можно получить стикеры только для сборочных заданий, находящихся на сборке — статус confirm.

Доступны размеры:

  • 580x400 px при width=58&height=40 в запросе
  • 400x300 px при width=40&height=30 в запросе
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Тип стикера

width
required
integer
Enum: 58 40

Ширина стикера

height
required
integer
Enum: 40 30

Высота стикера

Request Body schema: application/json
orders
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "stickers": [
    ]
}

Получить стикеры сборочных заданий кроссбордера{{ /api/v3/orders/stickers/cross-border }}

Описание метода

Метод возвращает список стикеров сборочных заданий кроссбордера, в формате PDF.

Ограничения:

  • За один запрос можно получить максимум 100 стикеров.
  • Можно получить стикеры только для сборочных заданий, находящихся на сборке или в доставке — статусы confirm, complete.
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "stickers": [
    ]
}

История статусов для сборочных заданий кроссбордера{{ /api/v3/orders/status/history }}

Описание метода

Метод возвращает историю статусов для сборочных заданий кроссбордера.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
Array of integers [ 1 .. 100 ] items

ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Заказы с информацией по клиенту{{ /api/v3/orders/client }}

Описание метода

Метод позволяет получать информацию о покупателе по ID сборочного задания.

Только для кроссбордера из Турции.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Список заказов

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Метаданные FBS

Для доступа к методам используйте токен для категории Маркетплейс
Узнать больше о метаданных можно в справочном центре

С помощью этих методов вы можете получать, удалять и редактировать метаданные сборочных заданий:

Получить метаданные сборочных заданий{{ /api/marketplace/v3/orders/meta }}

Описание метода

Метод возвращает метаданные сборочных заданий по списку их ID.

Перечень метаданных, доступных для сборочного задания, можно получить в списке новых сборочных заданий, поля requiredMeta и optionalMeta.

Возможные метаданные:

Если в ответе не вернулись какие-либо из объектов метаданных, значит, у сборочного задания не может быть таких метаданных — и добавить их нельзя.

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <= 100 items

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить метаданные сборочного задания{{ /api/v3/orders/{orderId}/meta }} Deprecated

Описание метода

Данный метод устарел. Он будет удалён 24 декабря

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Удалить метаданные сборочного задания{{ /api/v3/orders/{orderId}/meta }}

Описание метода

Метод удаляет значение метаданных сборочного задания для переданного ключа.

Возможные метаданные:

Можно передать только один ключ.

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

query Parameters
key
string

Название метаданных для удаления (imei, uin, gtin, sgtin). Передается только одно значение.

Responses

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequest",
  • "message": "Переданы некорректные данные"
}

Закрепить за сборочным заданием код маркировки товара{{ /api/v3/orders/{orderId}/meta/sgtin }}

Описание метода

Метод позволяет закрепить за сборочным заданием код маркировки Честный знак.

Закрепить код маркировки можно только если в метаданных сборочного задания есть поле sgtin, а сборочное задание находится в статусе confirm.

Получить загруженные маркировки можно в метаданных сборочного задания.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
sgtins
Array of strings [ 1 .. 100 ] items

Массив кодов маркировки. Допускается от 16 до 135 символов для кода одной маркировки.

Responses

Request samples

Content type
application/json
{
  • "sgtins": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием УИН{{ /api/v3/orders/{orderId}/meta/uin }}

Описание метода

Метод обновляет УИН в метаданных сборочного задания — уникальный идентификационный номер.

У одного сборочного задания может быть только один УИН.

Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
uin
required
string = 16 characters

УИН

Responses

Request samples

Content type
application/json
{
  • "uin": "1234567890123456"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием IMEI{{ /api/v3/orders/{orderId}/meta/imei }}

Описание метода

Метод обновляет IMEI в метаданных сборочного задания.

У одного сборочного задания может быть только один IMEI. Если у устройства два IMEI — IMEI и IMEI2 или IMEI1 и IMEI2 — укажите только IMEI или IMEI1. IMEI2 указывать не нужно.

Добавлять маркировку можно только для заказов, которые находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
imei
required
string = 15 characters

IMEI

Responses

Request samples

Content type
application/json
{
  • "imei": "123456789012345"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием GTIN{{ /api/v3/orders/{orderId}/meta/gtin }}

Описание метода

Метод обновляет GTIN в метаданных сборочного задания — уникальный ID товара в Беларуси.

У одного сборочного задания может быть только один GTIN.

Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
gtin
required
string = 13 characters

GTIN

Responses

Request samples

Content type
application/json
{
  • "gtin": "1234567890123"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием срок годности товара{{ /api/v3/orders/{orderId}/meta/expiration }}

Описание метода

Метод закрепляет за сборочным заданием срок годности товара. Товар годен до указанной даты.
Добавить срок годности можно только для заказов, которые доставляются WB и находятся в статусе confirm.

Получить загруженные данные можно в метаданных сборочного задания. Чтобы изменить срок годности, отправьте запрос с новой датой. Удалить срок годности из метаданных сборочного задания невозможно.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
expiration
string <date (dd.mm.yyyy)>

Дата, до которой годен товар. Не менее 30 дней с текущей даты

Responses

Request samples

Content type
application/json
{
  • "expiration": "12.09.2030"
}

Response samples

Content type
application/json
Example

Указан срок меньше допустимого

{
  • "code": "LowExpirationDate",
  • "message": "Не удалось обновить срок годности. Указан срок меньше допустимого"
}

Поставки FBS

Для доступа к методам используйте токен для категории Маркетплейс
Узнать больше о поставках FBS можно в справочном центре

Для работы с поставками:

Пункты 3-5 обязательны к выполнению при доставке поставки на пункт выдачи заказов (ПВЗ).
  1. Создайте новую поставку. В ответ вернется ID созданной поставки в формате WB-GI-1234567.
  2. В текущую новую поставку добавьте сборочные задания, которые вы повезёте на склад или ПВЗ. После того, как сборочные задания будут добавлены к поставке, они будут переведены в статус confirm — на сборке.
  3. Добавьте короба в поставку.
  4. Проверьте список коробов.
  5. Получите стикеры коробов. Распечатайте и наклейте стикеры на короба.
  6. После того как поставка будет укомплектована нужными сборочными заданиями, необходимо передать её в доставку. Если поставка не была передана в доставку, то при сканировании её QR-кода или приёмке первого товара на ПВЗ поставка автоматически закроется. При передаче сборочных заданий в доставку они будут автоматически собраны и переведены в статус complete — в доставке.
  7. Если поставка была отсканирована в пункте приёмки, но при этом в ней всё ещё есть неотсканированные товары, спустя определённое время необходимо доставить их повторно. Проверьте все сборочные задания, требующие повторной отгрузки на данный момент. Данные сборочные задания можно перевести в другую активную поставку. Сборочное задание также будет переведено в статус confirm — на сборке.

Также вы можете:

  1. Удалить короба из поставки, но только пока поставка находится на сборке.
  2. Получить список всех сборочных заданий, добавленных к поставке.
  3. Получить информацию обо всех поставках продавца или о конкретной поставке.
  4. Удалить поставку при условии, что она активна и за ней не закреплены сборочные задания.
  5. Перемещать сборочные задания между активными поставками. Нельзя перемещать сборочное задание из уже закрытой поставки, только если оно не требует повторной отгрузки.
  6. Получить QR-код поставки в форматах SVG, ZPL или PNG. Доступно только после передачи поставки в доставку.

Создать новую поставку{{ /api/v3/supplies }}

Описание метода

Метод создаёт новую поставку.

Ограничения:

  • Только для сборочных заданий по модели FBS.
  • При добавлении в поставку все передаваемые сборочные задания в статусе new будут автоматически переведены в статус confirm — на сборке.
  • Если вы переведёте сборочное задание в статус cancel — отмена продавцом, прикрепленное сборочное задание автоматически удалится из поставки.
  • Поставку можно собрать только из сборочных заданий (заказов) одного габаритного типа cargoType. Новая поставка не обладает габаритным признаком, она приобретает габаритный признак первого заказа, добавленного в поставку.
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
name
string [ 1 .. 128 ] characters

Наименование поставки

Responses

Request samples

Content type
application/json
{
  • "name": "Тестовая поставка"
}

Response samples

Content type
application/json
{
  • "id": "WB-GI-1234567"
}

Получить список поставок{{ /api/v3/supplies }}

Описание метода

Метод возвращает список поставок.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Параметр пагинации. Устанавливает предельное количество возвращаемых данных.

next
required
integer <int64>

Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноимённого поля в ответе.

Responses

Response samples

Content type
application/json
{
  • "next": 13833711,
  • "supplies": [
    ]
}

Добавить сборочные задания к поставке{{ /api/marketplace/v3/supplies/{supplyId}/orders }}

Описание метода

Метод добавляет до 100 сборочных заданий к поставке и переводит их в статус confirm — на сборке.

Может перемещать сборочные задания:

  • между активными поставками
  • из закрытой поставки в активную, если сборочные задания требуют повторной отгрузки
В пустую поставку можно добавить сборочные задания любого габаритного типа. Поставка приобретает габаритный тип первого добавленного сборочного задания из поля cargoType.
После этого в поставку можно добавить сборочные задания только того же габаритного типа, что и у поставки.
В поставку нельзя добавить сборочные задания, поступившие на разные склады.
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Request Body schema: application/json
required
orders
Array of integers [ 1 .. 100 ] items

ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Добавить сборочное задание к поставке{{ /api/v3/supplies/{supplyId}/orders/{orderId} }} Deprecated

Описание метода

Данный метод устарел. Он будет удалён 18 декабря

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить информацию о поставке{{ /api/v3/supplies/{supplyId} }}

Описание метода

Метод возвращает подробную информацию о поставке.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "id": "WB-GI-1234567",
  • "done": true,
  • "createdAt": "2022-05-04T07:56:29Z",
  • "closedAt": "2022-05-04T07:56:29Z",
  • "scanDt": "2022-05-04T07:56:29Z",
  • "name": "Тестовая поставка",
  • "cargoType": 0,
  • "destinationOfficeId": 123
}

Удалить поставку{{ /api/v3/supplies/{supplyId} }}

Описание метода

Метод удаляет поставку, если она активна и за ней не закреплено ни одно сборочное задание.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить ID сборочных заданий поставки{{ /api/marketplace/v3/supplies/{supplyId}/order-ids }}

Описание метода

Метод возвращает список ID сборочных заданий, закреплённых за поставкой.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string

ID поставки

Responses

Response samples

Content type
application/json
{
  • "orderIds": [
    ]
}

Получить сборочные задания в поставке{{ /api/v3/supplies/{supplyId}/orders }} Deprecated

Описание метода

Данный метод устарел. Он будет удалён 17 декабря

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Передать поставку в доставку{{ /api/v3/supplies/{supplyId}/deliver }}

Описание метода

Метод закрывает поставку и переводит все сборочные задания в ней в статус complete — в доставке. После закрытия поставки добавить новые сборочные задания к ней нельзя.

Если поставка не была передана в доставку, то при приёмке первого товара поставка автоматически закроется.

Передать поставку в доставку можно только если в ней:

  • есть хотя бы одно сборочное задания
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить QR-код поставки{{ /api/v3/supplies/{supplyId}/barcode }}

Описание метода

Метод возвращает QR-код поставки в форматах:

  • SVG
  • ZPLV (вертикальный)
  • ZPLH (горизонтальный)
  • PNG

QR-код поставки можно получить только если поставка передана в доставку.

Размер — 580x400 px.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Тип стикера

Responses

Response samples

Content type
application/json
{
  • "barcode": "WB-GI-12345678",
  • "file": "U3dhZ2dlciByb2Nrcw=="
}

Получить список коробов поставки{{ /api/v3/supplies/{supplyId}/trbx }}

Описание метода

Возвращает список коробов поставки.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "trbxes": [
    ]
}

Добавить короба к поставке{{ /api/v3/supplies/{supplyId}/trbx }}

Описание метода

Метод добавляет требуемое количество коробов в поставку.

Короба необходимо добавлять только в поставки, отгружаемые на ПВЗ.
Можно добавить только в открытую поставку.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Request Body schema: application/json
amount
required
integer [ 1 .. 1000 ]

Количество коробов, которые необходимо добавить к поставке.

Responses

Request samples

Content type
application/json
{
  • "amount": 4
}

Response samples

Content type
application/json
{
  • "trbxIds": [
    ]
}

Удалить короба из поставки{{ /api/v3/supplies/{supplyId}/trbx }}

Описание метода

Метод даляет короба из поставки.

Можно удалить только пока поставка на сборке.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Request Body schema: application/json
trbxIds
required
Array of strings

Список ID коробов, которые необходимо удалить.

Responses

Request samples

Content type
application/json
{
  • "trbxIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить стикеры коробов поставки{{ /api/v3/supplies/{supplyId}/trbx/stickers }}

Описание метода

Метод возвращает QR-стикеры в форматах:

  • SVG
  • ZPLV (вертикальный)
  • ZPLH (горизонтальный)
  • PNG

    Размер стикеров — 580x400 px.
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Тип стикера

Request Body schema: application/json
trbxIds
required
Array of strings

Список ID коробов, по которым необходимо вернуть стикеры.

Responses

Request samples

Content type
application/json
{
  • "trbxIds": [
    ]
}

Response samples

Content type
application/json
{
  • "stickers": [
    ]
}

Пропуска FBS

Для доступа к методам используйте токен для категории Маркетплейс

Через эти методы вы можете:

  1. Получать список складов WB, для которых требуется пропуск.
  2. Получать список пропусков.
  3. Создавать новые пропуска.
  4. Обновлять пропуска.
  5. Удалять пропуска.

Получить список складов, для которых требуется пропуск{{ /api/v3/passes/offices }}

Описание метода

Метод возвращает список складов для привязки к пропуску продавца.

Данные, которые возвращает метод, могут меняться. Рекомендуем периодически синхронизировать список
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получить список пропусков{{ /api/v3/passes }}

Описание метода

Метод возвращает список всех созданных пропусков продавца.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Создать пропуск{{ /api/v3/passes }}

Описание метода

Метод создаёт пропуск продавца с привязкой к складу WB.

Пропуск действует 48 часов со времени создания.

Максимум 1 запрос в 10 минут на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required

Общая длина ФИО ограничена от 6 до 100 символов. В номере машины могут быть только буквы и цифры.

firstName
required
string non-empty

Имя водителя

lastName
required
string non-empty

Фамилия водителя

carModel
required
string [ 1 .. 100 ] characters

Марка машины

carNumber
required
string [ 6 .. 9 ] characters

Номер машины

officeId
required
integer <int64> >= 1

ID склада

Responses

Request samples

Content type
application/json
{
  • "firstName": "Александр",
  • "lastName": "Петров",
  • "carModel": "Lamborghini",
  • "carNumber": "A456BC123",
  • "officeId": 15
}

Response samples

Content type
application/json
{
  • "id": 2
}

Обновить пропуск{{ /api/v3/passes/{passId} }}

Описание метода

Метод обновляет данные пропуска продавца. В том числе, можно обновить данные привязанного склада WB.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
passId
required
integer <int64>
Example: 45

ID пропуска

Request Body schema: application/json
required

Общая длина ФИО ограничена от 6 до 100 символов. В номере машины могут быть только буквы и цифры.

firstName
required
string non-empty

Имя водителя

lastName
required
string >= 6 characters

Фамилия водителя

carModel
required
string [ 1 .. 100 ] characters

Марка машины

carNumber
required
string [ 6 .. 9 ] characters

Номер машины

officeId
required
integer <int64> >= 1

ID склада

Responses

Request samples

Content type
application/json
{
  • "firstName": "Александр",
  • "lastName": "Петров",
  • "carModel": "Lamborghini",
  • "carNumber": "A456BC123",
  • "officeId": 15
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Удалить пропуск{{ /api/v3/passes/{passId} }}

Описание метода

Метод удаляет пропуск продавца из списка.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
passId
required
integer <int64>
Example: 45

ID пропуска

Responses

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}
Документация — WB API
Поиск

Заказы DBW (ordersdbw)

Управление сборочными заданиями и метаданными заказов DBW (Доставка курьером WB).

Заказы DBW

Управление сборочными заданиями и метаданными заказов DBW (Доставка курьером WB).

Сборочные задания DBW

Для доступа к методам используйте токен для категории Маркетплейс

Для работы со сборочными заданиями DBW:

  1. Получите новое сборочное задание.
  2. Переведите его на сборку.
  3. После перевода на сборку для заказа становится доступной информация о курьере (телефон, номер автомобиля).
    Чтобы курьер мог связаться с вами привяжите свои контакты к складу. Вы так же можете получить текущий список своих контактов.
  4. Получите, распечатайте и прикрепите стикеры.
  5. Переведите сборочное задание в доставку.
  6. Дождитесь курьера.
  7. Курьер забирает заказ и отвозит клиенту.
  8. Клиент принимает заказ или отказывается от него.
  9. Если клиент принимает заказ, курьер переводит сборочное задание в статус receive. Если отказывается — в reject.
Узнать больше о сборочных заданиях DBW можно в справочном центре

Получить список новых сборочных заданий{{ /api/v3/dbw/orders/new }}

Описание метода

Метод возвращает список всех новых сборочных заданий, которые есть у продавца на момент запроса.

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить информацию о завершенных сборочных заданиях{{ /api/v3/dbw/orders }}

Описание метода

Метод возвращает информацию о завершенных сборочных заданиях.

Можно получить данные за заданный период, максимум 30 календарных дней одним запросом.

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Параметр пагинации. Устанавливает предельное количество возвращаемых данных

next
required
integer <int64>

Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноименного поля в ответе

dateFrom
required
integer

Дата начала периода в формате Unix timestamp

dateTo
required
integer

Дата конца периода в формате Unix timestamp

Responses

Response samples

Content type
application/json
{
  • "next": 13833711,
  • "orders": [
    ]
}

Дата и время доставки{{ /api/v3/dbw/orders/delivery-date }}

Описание метода

Метод возвращает информацию о выбранных покупателем дате и времени доставки сборочных заданий.

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers[ items [ 1 .. 1000 ] items ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить статусы сборочных заданий{{ /api/v3/dbw/orders/status }}

Описание метода

Метод возвращает статусы сборочных заданий по их ID.

supplierStatus — статус сборочного задания. Триггер его изменения — действие самого продавца.

Возможные значения supplierStatus:

Статус Описание Как перевести сборочное задание в данный статус
new Новое сборочное задание
confirm На сборке Перевести сборочное задание на сборку
complete В доставке Перевести сборочное задание в доставку
receive Получено покупателем Переводится курьером
reject Отказ покупателя при получении Переводится курьером
cancel Отменено продавцом Отменить сборочное задание
cancel_missed_call Отмена по причине недозвона
Статус меняется автоматически



wbStatus — статус системы Wildberries.

Возможные значения wbStatus:

  • waiting — сборочное задание в работе
  • sold — заказ получен покупателем
  • canceled — отмена сборочного задания
  • canceled_by_client — покупатель отменил заказ при получении
  • declined_by_client — покупатель отменил заказ в первый чаc
    Отмена доступна покупателю в первый час с момента заказа, если заказ не переведен на сборку
  • defect — отмена заказа по причине брака
  • canceled_by_missed_call — отмена заказа по причине недозвона
  • postponed_delivery — курьерская доставка отложена
Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Перевести на сборку{{ /api/v3/dbw/orders/{orderId}/confirm }}

Описание метода

Метод переводит сборочное задание в статус confirm — на сборке.

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": ""
}

Получить стикеры сборочных заданий{{ /api/v3/dbw/orders/stickers }}

Описание метода

Метод возвращает список стикеров для сборочных заданий.

Можно получить стикер в форматах:

  • SVG
  • ZPLV (вертикальный)
  • ZPLH (горизонтальный)
  • PNG

Ограничения:

  • За один запрос можно получить максимум 100 стикеров.
  • Можно получить стикеры только для сборочных заданий, находящихся на сборке — статус confirm.

Доступны размеры:

  • 580x400 px при width=58&height=40 в запросе
  • 400x300 px при width=40&height=30 в запросе
Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Тип стикера

width
required
integer
Enum: 58 40

Ширина стикера

height
required
integer
Enum: 40 30

Высота стикера

Request Body schema: application/json
orders
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "stickers": [
    ]
}

Перевести в доставку{{ /api/v3/dbw/orders/{orderId}/assemble }}

Описание метода

Метод переводит сборочное задание в статус complete — в доставке.

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": ""
}

Информация о курьере{{ /api/v3/dbw/orders/courier }}

Описание метода

Метод возвращает контактные данные и номер автомобиля курьера по ID сборочного задания.
Для сборочных заданий в статусах confirm, complete.

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Отменить сборочное задание{{ /api/v3/dbw/orders/{orderId}/cancel }}

Описание метода

Метод отменяет сборочное задание и переводит в статус cancel — отменено продавцом.

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": ""
}

Метаданные DBW

Для доступа к методам используйте токен для категории Маркетплейс
Узнать больше о метаданных можно в справочном центре

С помощью этих методов вы можете получать, удалять и редактировать метаданные сборочных заданий:

Получить метаданные сборочного задания{{ /api/v3/dbw/orders/{orderId}/meta }}

Описание метода

Метод возвращает метаданные сборочного задания.

Перечень метаданных, доступных для сборочного задания, можно получить в списке новых сборочных заданий, поле requiredMeta.

Возможные метаданные:

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Удалить метаданные сборочного задания{{ /api/v3/dbw/orders/{orderId}/meta }}

Описание метода

Метод удаляет значение метаданных сборочного задания для переданного ключа.

Возможные метаданные:

Можно передать только один ключ.

Лимит запросов на один аккаунт продавца для следующих методов DBW:
  • получение и обновление списка контактов
  • получение и удаление метаданных
  • методы сборочных заданий
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

query Parameters
key
string

Название метаданных для удаления (imei, uin, gtin, sgtin). Передается только одно значение

Responses

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": ""
}

Закрепить за сборочным заданием код маркировки товара{{ /api/v3/dbw/orders/{orderId}/meta/sgtin }}

Описание метода

Метод позволяет закрепить за сборочным заданием код маркировки Честный знак.

Закрепить код маркировки можно только если в метаданных сборочного задания есть поле sgtin, а сборочное задание находится в статусе confirm.

Получить загруженные маркировки можно в метаданных сборочного задания.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных модели DBW:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
sgtins
Array of strings [ 1 .. 24 ] items

Массив кодов маркировки. Допускается от 16 до 135 символов для кода одной маркировки

Responses

Request samples

Content type
application/json
{
  • "sgtins": [
    ]
}

Response samples

Content type
application/json
Example

Некорректное тело запроса

{
  • "code": "IncorrectRequestBody",
  • "message": ""
}

Закрепить за сборочным заданием УИН (уникальный идентификационный номер){{ /api/v3/dbw/orders/{orderId}/meta/uin }}

Описание метода

Метод обновляет УИН в метаданных сборочного задания — уникальный идентификационный номер.

У одного сборочного задания может быть только один УИН.

Добавлять маркировку можно только для заказов, которые находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных модели DBW:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
uin
required
string = 16 characters

УИН

Responses

Request samples

Content type
application/json
{
  • "uin": "1234567890123456"
}

Response samples

Content type
application/json
Example

Некорректное тело запроса

{
  • "code": "IncorrectRequestBody",
  • "message": ""
}

Закрепить за сборочным заданием IMEI{{ /api/v3/dbw/orders/{orderId}/meta/imei }}

Описание метода

Метод обновляет IMEI в метаданных сборочного задания.

У одного сборочного задания может быть только один IMEI.

Добавлять маркировку можно только для заказов, которые находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных модели DBW:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
imei
required
string = 15 characters

IMEI

Responses

Request samples

Content type
application/json
{
  • "imei": "123456789012345"
}

Response samples

Content type
application/json
Example

Некорректное тело запроса

{
  • "code": "IncorrectRequestBody",
  • "message": ""
}

Закрепить за сборочным заданием GTIN{{ /api/v3/dbw/orders/{orderId}/meta/gtin }}

Описание метода

Метод обновляет GTIN в метаданных сборочного задания — уникальный ID товара в Беларуси.

У одного сборочного задания может быть только один GTIN.

Добавлять маркировку можно только для заказов, которые находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных модели DBW:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
gtin
required
string = 13 characters

GTIN

Responses

Request samples

Content type
application/json
{
  • "gtin": "1234567890123"
}

Response samples

Content type
application/json
Example

Некорректное тело запроса

{
  • "code": "IncorrectRequestBody",
  • "message": ""
}
Документация — WB API
Поиск

Заказы DBS (order)

Узнать больше о заказах DBS можно в справочном центре

Управление сборочными заданиями и метаданными заказов DBS (Delivery by Seller).

Заказы DBS

Узнать больше о заказах DBS можно в справочном центре

Управление сборочными заданиями и метаданными заказов DBS (Delivery by Seller).

Сборочные задания DBS

Для доступа к методам используйте токен для категории Маркетплейс
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с заказами DBS
Узнать больше о сборочных заданиях DBS можно в справочном центре

Для работы со сборочными заданиями DBS:

  1. Получите новое сборочное задание и сохраните его до перевода на сборку. Если вы не сохраните информацию о сборочном задании заранее, вы сможете получить ее только после завершения задания (отмены или продажи). Проверяйте дату и время доставки.
  2. Переведите его на сборку.
  3. После перевода на сборку для заказа становится доступной информация о покупателе (имя, телефон).
  4. Переведите в доставку.
  5. После доставки задания покупателю вам необходимо сообщить на наш сервер, что сборочное задание принято покупателем или, что покупатель отказался от сборочного задания.

Получить список новых сборочных заданий{{ /api/v3/dbs/orders/new }}

Описание метода

Метод возвращает список всех новых сборочных заданий, которые есть у продавца на момент запроса.

Лимит запросов на один аккаунт продавца для методов сборочных заданий DBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить информацию о завершенных сборочных заданиях{{ /api/v3/dbs/orders }}

Описание метода

Метод возвращает информацию о завершенных сборочных заданиях после продажи или отмены заказа.

Можно получить данные за заданный период, максимум 30 календарных дней одним запросом.

Лимит запросов на один аккаунт продавца для методов сборочных заданий DBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Параметр пагинации. Устанавливает предельное количество возвращаемых данных.

next
required
integer <int64>

Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноименного поля в ответе.

dateFrom
required
integer

Дата начала периода в формате Unix timestamp

dateTo
required
integer

Дата конца периода в формате Unix timestamp

Responses

Response samples

Content type
application/json
{
  • "next": 13833711,
  • "orders": [
    ]
}

Получить информацию о платной доставке{{ /api/v3/dbs/groups/info }}

Описание метода

Метод возвращает информацию о платной доставке сборочных заданий, которые поступили на один склад (warehouseId) в рамках одной транзакции покупателя (orderUid).

Лимит запросов на один аккаунт продавца для методов сборочных заданий DBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
groups
Array of strings <= 1000 items

Список значений groupId. Можно получить из новых и завершенных сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Информация о покупателе{{ /api/v3/dbs/orders/client }}

Описание метода

Метод возвращает информацию о покупателе по ID сборочных заданий.

Лимит запросов на один аккаунт продавца для методов сборочных заданий DBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Дата и время доставки{{ /api/v3/dbs/orders/delivery-date }}

Описание метода

Метод возвращает информацию о выбранных покупателем дате и времени доставки сборочных заданий.

Лимит запросов на один аккаунт продавца для методов сборочных заданий DBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers[ items [ 1 .. 1000 ] items ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить статусы сборочных заданий{{ /api/v3/dbs/orders/status }}

Описание метода

Метод возвращает статусы сборочных заданий по их ID.

supplierStatus — статус сборочного задания. Триггер его изменения — действие самого продавца.

Возможные значения supplierStatus:

Статус Описание Как перевести сборочное задание в данный статус
new Новое сборочное задание
confirm На сборке Перевести сборочное задание на сборку
deliver В доставке Перевести сборочное задание в доставку
receive Получено покупателем Сообщить, что заказ принят покупателем
reject Отказ покупателя при получении Сообщить, что покупатель отказался от заказа
cancel Отменено продавцом Отменить сборочное задание
cancel_missed_call Отмена по причине недозвона Статус меняется автоматически



wbStatus — статус системы Wildberries.

Возможные значения wbStatus:

  • waiting — сборочное задание в работе
  • sold — заказ получен покупателем
  • canceled — отмена сборочного задания
  • canceled_by_client — покупатель отменил заказ при получении
  • declined_by_client — покупатель отменил заказ в первый чаc
    Отмена доступна покупателю в первый час с момента заказа, если заказ не переведен на сборку
  • defect — отмена заказа по причине брака
  • ready_for_pickup — сборочное задание прибыло на ПВЗ
  • canceled_by_missed_call — отмена по причине недозвона
Лимит запросов на один аккаунт продавца для методов сборочных заданий DBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Отменить сборочное задание{{ /api/v3/dbs/orders/{orderId}/cancel }}

Описание метода

Метод отменяет сборочное задание и переводит в статус cancel — отменено продавцом.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Перевести на сборку{{ /api/v3/dbs/orders/{orderId}/confirm }}

Описание метода

Метод переводит сборочное задание в статус confirm — на сборке.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Перевести в доставку{{ /api/v3/dbs/orders/{orderId}/deliver }}

Описание метода

Метод переводит сборочное задание в статус deliver — в доставке.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Сообщить, что заказ принят покупателем{{ /api/v3/dbs/orders/{orderId}/receive }}

Описание метода

Метод переводит сборочное задание в статус receive — получено покупателем.

Лимит запросов на один аккаунт продавца для методов сборочных заданий DBS:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 33 запроса

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
required
code
string

Код подтверждения.
Отображается у покупателя на сайте и в приложении Wildberries

Responses

Request samples

Content type
application/json
{
  • "code": "123456"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Сообщить, что покупатель отказался от заказа{{ /api/v3/dbs/orders/{orderId}/reject }}

Описание метода

Метод переводит сборочное задание в статус reject — отказ при получении.

Лимит запросов на один аккаунт продавца для методов сборочных заданий DBS:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 33 запроса

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
required
code
string

Код подтверждения.
Отображается у покупателя на сайте и в приложении Wildberries

Responses

Request samples

Content type
application/json
{
  • "code": "123456"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Метаданные DBS

Для доступа к методам используйте токен для категории Маркетплейс
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с заказами DBS
Узнать больше о метаданных можно в справочном центре

С помощью этих методов вы можете получать, удалять и редактировать метаданные сборочных заданий:

Получить метаданные сборочного задания{{ /api/v3/dbs/orders/{orderId}/meta }}

Описание метода

Метод возвращает метаданные сборочного задания.

Перечень метаданных, доступных для сборочного задания, можно получить в списке новых сборочных заданий, поле requiredMeta.

Возможные метаданные:

Если ответ вернулся с пустой структурой meta, значит у сборочного задания нет метаданных и добавить их нельзя.

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных DBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Удалить метаданные сборочного задания{{ /api/v3/dbs/orders/{orderId}/meta }}

Описание метода

Метод удаляет значение метаданных сборочного задания для переданного ключа.

Возможные метаданные:

Можно передать только один ключ.

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных DBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

query Parameters
key
string

Название метаданных для удаления (imei, uin, gtin, sgtin). Передается только одно значение.

Responses

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Закрепить за сборочным заданием код маркировки товара{{ /api/v3/dbs/orders/{orderId}/meta/sgtin }}

Описание метода

Метод позволяет закрепить за сборочным заданием код маркировки Честный знак.

Закрепить код маркировки можно только если в метаданных сборочного задания есть поле sgtin, а сборочное задание находится в статусе confirm.

Получить загруженные маркировки можно в метаданных сборочного задания.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных DBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
sgtins
Array of strings [ 1 .. 24 ] items

Массив кодов маркировки. Допускается от 16 до 135 символов для кода одной маркировки.

Responses

Request samples

Content type
application/json
{
  • "sgtins": [
    ]
}

Response samples

Content type
application/json
Example

Некорректное тело запроса

{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием УИН (уникальный идентификационный номер){{ /api/v3/dbs/orders/{orderId}/meta/uin }}

Описание метода

Метод обновляет УИН в метаданных сборочного задания — уникальный идентификационный номер.

У одного сборочного задания может быть только один УИН.

Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных DBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
uin
required
string = 16 characters

УИН

Responses

Request samples

Content type
application/json
{
  • "uin": "1234567890123456"
}

Response samples

Content type
application/json
Example

Некорректное тело запроса

{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием IMEI{{ /api/v3/dbs/orders/{orderId}/meta/imei }}

Описание метода

Метод обновляет IMEI в метаданных сборочного задания.

У одного сборочного задания может быть только один IMEI.

Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных DBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
imei
required
string = 15 characters

IMEI

Responses

Request samples

Content type
application/json
{
  • "imei": "123456789012345"
}

Response samples

Content type
application/json
Example

Некорректное тело запроса

{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием GTIN{{ /api/v3/dbs/orders/{orderId}/meta/gtin }}

Описание метода

Метод обновляет GTIN в метаданных сборочного задания — уникальный ID товара в Беларуси.

У одного сборочного задания может быть только один GTIN.

Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных DBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
gtin
required
string = 13 characters

GTIN

Responses

Request samples

Content type
application/json
{
  • "gtin": "1234567890123"
}

Response samples

Content type
application/json
Example

Некорректное тело запроса

{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}
Документация — WB API
Поиск

Заказы Самовывоз (instorepickup)

Управление сборочными заданиями и метаданными заказов модели Самовывоз.

Заказы Самовывоз

Управление сборочными заданиями и метаданными заказов модели Самовывоз.

Сборочные задания Самовывоз

Для доступа к методам используйте токен для категории Маркетплейс
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с заказами Самовывоз

Порядок работы:

  1. Получите новое сборочное задание
  2. Переведите его на сборку
  3. После этого для задания становится доступной информация по покупателю (имя, телефон)
  4. После сборки сообщите, что сборочное задание готово к выдаче
  5. После того как сборочное задание получит статус Готов к выдаче, вы можете проверить, принадлежит ли это сборочное задание покупателю.
  6. После доставки задания покупателю вам необходимо сообщить на наш сервер, что заказ принят покупателем или что покупатель отказался от заказа

Получить список новых сборочных заданий{{ /api/v3/click-collect/orders/new }}

Описание метода

Метод возвращает список всех новых сборочных заданий, которые есть у продавца на момент запроса.

Лимит запросов на один аккаунт продавца для методов сборочных заданий Самовывоз:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Перевести на сборку{{ /api/v3/click-collect/orders/{orderId}/confirm }}

Описание метода

Метод переводит сборочное задание в статус confirm — на сборке.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Сообщить, что сборочное задание готово к выдаче{{ /api/v3/click-collect/orders/{orderId}/prepare }}

Описание метода

Метод переводит сборочное задание в статус prepare — готово к выдаче.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Информация о покупателе{{ /api/v3/click-collect/orders/client }}

Описание метода

Метод возвращает информацию о покупателе по ID сборочного задания.

Доступно только для сборочных заданий в статусах:

  • confirm — на сборке
  • prepare — готов к выдаче
Лимит запросов на один аккаунт продавца для методов сборочных заданий Самовывоз:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Проверить, что заказ принадлежит покупателю{{ /api/v3/click-collect/orders/client/identity }}

Описание метода

Метод сообщает, принадлежит ли проверяемый заказ покупателю или нет по переданному коду.

Доступно, если хотя бы одно сборочное задание из заказа находится в статусе prepare - готов к выдаче.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 30 запросов 2 секунды 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orderCode
string

Уникальный ID заказа покупателя

passcode
string

Код подтверждения

Responses

Request samples

Content type
application/json
{
  • "orderCode": "170046918-0011",
  • "passcode": "4567"
}

Response samples

Content type
application/json
{
  • "ok": true
}

Сообщить, что заказ принят покупателем{{ /api/v3/click-collect/orders/{orderId}/receive }}

Описание метода

Метод переводит сборочное задание в статус receive — получено покупателем.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Сообщить, что покупатель отказался от заказа{{ /api/v3/click-collect/orders/{orderId}/reject }}

Описание метода

Метод переводит сборочное задание в статус reject — отказ при получении.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить статусы сборочных заданий{{ /api/v3/click-collect/orders/status }}

Описание метода

Метод возвращает статусы сборочных заданий по их ID.

supplierStatus — статус сборочного задания. Триггер его изменения - действие самого продавца.

Возможные значения supplierStatus:

Статус Описание Как перевести сборочное задание в данный статус
new Новое сборочное задание
confirm На сборке Перевести сборочное задание на сборку
prepare Готов к выдаче Сообщить, что сборочное задание готово к выдаче
receive Получено покупателем Сообщить, что заказ принят покупателем
reject Отказ покупателя при получении Сообщить, что покупатель отказался от заказа
cancel Отменено продавцом Отменить сборочное задание
cancel_shelf_life Отмена по истечении срока хранения Переводится автоматически по возникновению события



wbStatus — статус системы Wildberries.

Возможные значения wbStatus:

  • waiting - сборочное задание в работе
  • sold - заказ получен покупателем
  • canceled - отмена сборочного задания
  • canceled_by_client - покупатель отменил заказ при получении
  • declined_by_client - покупатель отменил заказ в первый чаc
    Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборку
  • defect - отмена заказа по причине брака
  • ready_for_pickup - сборочное задание готово к выдаче
Лимит запросов на один аккаунт продавца для методов сборочных заданий Самовывоз:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить информацию о завершённых сборочных заданиях{{ /api/v3/click-collect/orders }}

Описание метода

Метод возвращает информацию о завершённых сборочных заданиях после продажи или отмены заказа.

Можно получить данные за заданный период, максимум 30 календарных дней одним запросом.

Лимит запросов на один аккаунт продавца для методов сборочных заданий Самовывоз:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Параметр пагинации. Устанавливает предельное количество возвращаемых данных.

next
required
integer

Параметр пагинации. Устанавливает значение, с которого необходимо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноимённого поля в ответе

dateFrom
required
integer

Дата начала периода в формате Unix timestamp

dateTo
required
integer

Дата конца периода в формате Unix timestamp

Responses

Response samples

Content type
application/json
{
  • "next": 12345566,
  • "orders": [
    ]
}

Отменить сборочное задание{{ /api/v3/click-collect/orders/{orderId}/cancel }}

Описание метода

Метод отменяет сборочное задание и переводит в статус cancel — отменено продавцом.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Метаданные Самовывоз

Для доступа к методам используйте токен для категории Маркетплейс
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с заказами Самовывоз

С помощью этих методов вы можете получать, удалять и редактировать метаданные сборочных заданий:

Получить метаданные сборочного задания{{ /api/v3/click-collect/orders/{orderId}/meta }}

Описание метода

Метод возвращает метаданные сборочного задания.

Перечень метаданных, доступных для сборочного задания, можно получить в списке новых сборочных заданий, поле requiredMeta.

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных Самовывоз:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Удалить метаданные сборочного задания{{ /api/v3/click-collect/orders/{orderId}/meta }}

Описание метода

Метод удаляет значение метаданных сборочного задания для переданного ключа. Возможные метаданные: imei, uin, gtin, sgtin Передается только одно значение.

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных Самовывоз:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

query Parameters
key
required
string

Название метаданных для удаления (imei, uin, gtin, sgtin). Передается только одно значение.

Responses

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Закрепить за сборочным заданием код маркировки товара{{ /api/v3/click-collect/orders/{orderId}/meta/sgtin }}

Описание метода

Метод закрепляет за сборочным заданием код маркировки Честный знак.

Закрепить код маркировки можно только, если в метаданных сборочного задания есть поле sgtins, а сборочное задание находится в статусе confirm.

Получить загруженные маркировки можно в метаданных сборочного задания.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных Самовывоз:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Request Body schema: application/json
required
sgtins
Array of strings

Массив кодов маркировки. Допускается от 16 до 135 символов для кода одной маркировки

Responses

Request samples

Content type
application/json
{
  • "sgtins": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием УИН (уникальный идентификационный номер){{ /api/v3/click-collect/orders/{orderId}/meta/uin }}

Описание метода

Метод обновляет УИН сборочного задания. У одного сборочного задания может быть только один УИН. Добавлять маркировку можно только для сборочных заданий в статусе confirm и доставка которых осуществляется силами WB.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных Самовывоз:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Request Body schema: application/json
required
uin
string

УИН

Responses

Request samples

Content type
application/json
{
  • "uin": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием IMEI{{ /api/v3/click-collect/orders/{orderId}/meta/imei }}

Описание метода

Метод обновляет IMEI сборочного задания. У одного сборочного задания может быть только один IMEI. Добавлять маркировку можно только для сборочных заданий в статусе confirm и доставка которых осуществляется силами WB.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных Самовывоз:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Request Body schema: application/json
required
imei
string

IMEI

Responses

Request samples

Content type
application/json
{
  • "imei": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием GTIN{{ /api/v3/click-collect/orders/{orderId}/meta/gtin }}

Описание метода

Метод обновляет GTIN (уникальный ID товара в Беларуси) сборочного задания. У одного сборочного задания может быть только один GTIN. Добавлять маркировку можно только для сборочных заданий в статусе confirm и доставка которых осуществляется силами WB.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных Самовывоз:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 10 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

ID сборочного задания

Request Body schema: application/json
required
gtin
string

GTIN

Responses

Request samples

Content type
application/json
{
  • "gtin": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}
Документация — WB API
Поиск

Поставки FBW (ordersfbw)

Узнать больше о поставках FBW можно в справочном центре

В разделе описаны методы получения:

Поставки FBW

Узнать больше о поставках FBW можно в справочном центре

В разделе описаны методы получения:

Информация для формирования поставок

Для доступа к методам используйте токен для категории Поставки

Получение информации для формирования поставок на склады WB:

  1. Коэффициенты приёмки
  2. Опции приёмки
  3. Список складов
  4. Транзитные направления

Коэффициенты приёмки{{ /api/v1/acceptance/coefficients }}

Описание метода

Метод возвращает коэффициенты приёмки для конкретных складов на ближайшие 14 дней.

Приёмка для поставки доступна только при сочетании:
coefficient0 или 1
и allowUnloadtrue
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 6 запросов 10 секунд 6 запросов
Authorizations:
HeaderApiKey
query Parameters
warehouseIDs
string
Example: warehouseIDs=507,117501

ID складов.
По умолчанию возвращаются данные по всем складам

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Опции приёмки{{ /api/v1/acceptance/options }}

Описание метода

Метод возвращает информацию о том, какие склады и типы упаковки доступны для поставки. Список складов определяется по баркоду и количеству товара.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 6 запросов 10 секунд 6 запросов
Authorizations:
HeaderApiKey
query Parameters
warehouseID
string
Example: warehouseID=507

ID склада.
Если параметр не указан, возвращаются данные по всем складам.
Максимум одно значение

Request Body schema: application/json
required
Array (<= 5000 items)
quantity
integer [ 1 .. 999999 ]

Суммарное количество товаров, планируемых для поставки.
Максимум 999999

barcode
string

Баркод из карточки товара

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "requestId": "kr53d2bRKYmkK2N6zaNKHs"
}

Список складов{{ /api/v1/warehouses }}

Описание метода

Метод возвращает список складов WB.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 6 запросов 10 секунд 6 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Транзитные направления{{ /api/v1/transit-tariffs }}

Описание метода

Метод возвращает информацию о доступных транзитных направлениях.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 6 запросов 10 секунд 10 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Информация о поставках

Для доступа к методам используйте токен для категории Поставки

Получение информации о поставках товаров для хранения на складах WB:

  1. Список поставок
  2. Детали поставки
  3. Товары поставки
  4. Упаковка поставки

Список поставок{{ /api/v1/supplies }}

Описание метода

Метод возвращает список поставок, по умолчанию — последние 1000 поставок.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 30 запросов 2 секунды 10 запросов
Authorizations:
HeaderApiKey
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 1000

Количество записей в ответе

offset
integer
Default: 0

После какого элемента выдавать данные

Request Body schema: application/json
required
Array of objects (models.DateFilterRequest)

Фильтр по датам

statusIDs
Array of integers (models.HandySupplyStatus)
Items Enum: 1 2 3 4 5 6

Фильтр поставок по статусам. Возможные значения:

  • 1 — Не запланировано
  • 2 — Запланировано
  • 3 — Отгрузка разрешена
  • 4 — Идёт приёмка
  • 5 — Принято
  • 6 — Отгружено на воротах

Responses

Request samples

Content type
application/json
{
  • "dates": [
    ],
  • "statusIDs": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Детали поставки{{ /api/v1/supplies/{ID} }}

Описание метода

Метод возвращает детали поставки по ID.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 30 запросов 2 секунды 10 запросов
Authorizations:
HeaderApiKey
path Parameters
ID
required
integer

ID поставки или заказа

query Parameters
isPreorderID
boolean
Default: false

Поиск по:

  • true — ID заказа, если в ID передаёте ID заказа
  • false — ID поставки, если в ID передаёте ID поставки

Responses

Response samples

Content type
application/json
{
  • "phone": "+7 903 *** 98 62",
  • "statusID": 5,
  • "boxTypeID": 5,
  • "createDate": "2025-07-15T17:17:45+03:00",
  • "supplyDate": "2025-07-15T00:00:00+03:00",
  • "factDate": "2025-07-18T11:37:32+03:00",
  • "updatedDate": "2025-07-18T12:59:53+03:00",
  • "warehouseID": 507,
  • "warehouseName": "Коледино",
  • "actualWarehouseID": 507,
  • "actualWarehouseName": "Коледино",
  • "transitWarehouseID": null,
  • "transitWarehouseName": "",
  • "acceptanceCost": 5000,
  • "paidAcceptanceCoefficient": 10,
  • "rejectReason": null,
  • "supplierAssignName": "Магазн",
  • "storageCoef": "215",
  • "deliveryCoef": "200",
  • "quantity": 10,
  • "readyForSaleQuantity": 0,
  • "acceptedQuantity": 10,
  • "unloadingQuantity": 10,
  • "depersonalizedQuantity": 0
}

Товары поставки{{ /api/v1/supplies/{ID}/goods }}

Описание метода

Метод возвращает информацию о товарах в поставке.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 30 запросов 2 секунды 10 запросов
Authorizations:
HeaderApiKey
path Parameters
ID
required
integer

ID поставки или заказа

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Количество записей в ответе

offset
integer
Default: 0

После какого элемента выдавать данные

isPreorderID
boolean
Default: false

Поиск по:

  • true — ID заказа, если в ID передаёте ID заказа
  • false — ID поставки, если в ID передаёте ID поставки

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Упаковка поставки{{ /api/v1/supplies/{ID}/package }}

Описание метода

Метод возвращает информацию об упаковке поставки.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 30 запросов 2 секунды 10 запросов
Authorizations:
HeaderApiKey
path Parameters
ID
required
integer

ID поставки

Responses

Response samples

Content type
application/json
[
  • {
    }
]
Документация — WB API
Поиск

Маркетинг и продвижение (promotion)

Узнать больше о маркетинге и продвижении можно в справочном центре

Методы маркетинга и продвижения позволяют:

  1. Получать информацию о кампаниях продвижения и медиакампаниях.
  2. Создавать и управлять кампаниями.
  3. Настраивать параметры кампаний — кластеры фраз, продвигаемые товары и так далее.
  4. Управлять финансами кампаний.
  5. Выгружать статистику кампаний продвижения и медиакампаний.
  6. Работать с календарём акций.

Данные синхронизируются с базой раз в 3 минуты. Статусы кампаний меняются раз в минуту. Ставки кампаний меняются раз в 30 секунд.

Маркетинг и продвижение

Узнать больше о маркетинге и продвижении можно в справочном центре

Методы маркетинга и продвижения позволяют:

  1. Получать информацию о кампаниях продвижения и медиакампаниях.
  2. Создавать и управлять кампаниями.
  3. Настраивать параметры кампаний — кластеры фраз, продвигаемые товары и так далее.
  4. Управлять финансами кампаний.
  5. Выгружать статистику кампаний продвижения и медиакампаний.
  6. Работать с календарём акций.

Данные синхронизируются с базой раз в 3 минуты. Статусы кампаний меняются раз в минуту. Ставки кампаний меняются раз в 30 секунд.

Кампании

Для доступа к методам используйте токен для категории Продвижение

Методы получения списков рекламных кампаний, информации о кампаниях и информации о кампаниях с ручной ставкой

Списки кампаний{{ /adv/v1/promotion/count }}

Описание метода

Метод возвращает списки всех рекламных кампаний продавца с их ID. Кампании сгруппированы по типу и статусу, у каждой указана дата последнего изменения.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "adverts": [
    ],
  • "all": 3
}

Информация о кампаниях{{ /adv/v1/promotion/adverts }}

Описание метода

Метод возвращает информацию о рекламных кампаниях с устаревшим типом 8 по их статусам и ID.

Для получения информации о кампаниях с типом 9 используйте отдельный метод.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
status
integer
Enum: -1 4 7 8 9 11

Статус кампании:

  • -1 — удалена, процесс удаления будет завершён в течение 10 минут
  • 4 — готова к запуску
  • 7 — завершена
  • 8 — отменена
  • 9 — активна
  • 11 — на паузе
type
integer
Value: 8

Тип кампании:

  • 8 — единая ставка
order
string
Enum: "create" "change" "id"

Порядок:

  • create — по времени создания кампании
  • change — по времени последнего изменения кампании
  • id — по ID кампании
direction
string
Enum: "desc" "asc"

Направление:

  • desc — от большего к меньшему
  • asc — от меньшего к большему
Request Body schema: application/json
required
Array
integer

Список ID кампаний. Максимум 50.

Получить ID кампаний можно методом Списки кампаний

Responses

Request samples

Content type
application/json
[
  • 1234567,
  • 63453471
]

Response samples

Content type
application/json
Example
[
  • {
    }
]

Информация о кампаниях с ручной ставкой{{ /adv/v0/auction/adverts }}

Описание метода

Метод возвращает информацию о рекламных кампаниях с ручной ставкой по их статусам, типам оплаты и ID.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
ids
string
Example: ids=12345,23456,34567,45678,56789

ID кампаний, максимум 50 значений

statuses
string
Enum: "-1" "4" "7" "8" "9" "11"
Example: statuses=-1,4,8

Статусы кампаний:

  • -1 — удалена, процесс удаления будет завершён в течение 10 минут
  • 4 — готова к запуску
  • 7 — завершена
  • 8 — отменена
  • 9 — активна
  • 11 — на паузе
payment_type
string
Enum: "cpm" "cpc"

Тип оплаты:

  • cpm — за показы
  • cpc — за клик

Responses

Response samples

Content type
application/json
{
  • "adverts": [
    ]
}

Создание кампаний

Для доступа к методам используйте токен для категории Продвижение

Метод создания кампаний с единой или ручной ставкой, а также получения:

  1. Минимальных ставок для карточек товаров
  2. Предметов для кампаний
  3. Карточек товаров для кампаний

Конфигурационные значения Продвижения{{ /adv/v0/config }} Deprecated

Описание метода

Метод возвращает допустимые значения основных параметров конфигурации кампаний: например, минимальные ставки, доступные категории и максимальное количество товаров, которые можно добавить в кампанию.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ],
  • "config": [
    ]
}

Минимальные ставки для карточек товаров{{ /adv/v0/bids/min }}

Описание метода

Метод возвращает минимальные ставки для карточек товаров по типу оплаты и местам размещения.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 20 запросов 3 секунды 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer <int64>

ID кампании

nm_ids
required
Array of integers <int64> [ 1 .. 100 ] characters [ items <int64 > ]

Список артикулов WB

payment_type
required
string
Enum: "cpm" "cpc"

Тип оплаты: - cpm — за показы - cpc — за клик

placement_types
required
Array of strings
Items Enum: "combined" "search" "recommendation"

Места размещения:

  • search — поиск
  • recommendation — рекомендации
  • combined — поиск и рекомендации

Responses

Request samples

Content type
application/json
{
  • "advert_id": 98765432,
  • "nm_ids": [
    ],
  • "payment_type": "cpm",
  • "placement_types": [
    ]
}

Response samples

Content type
application/json
{
  • "bids": [
    ]
}

Создать кампанию{{ /adv/v2/seacat/save-ad }}

Описание метода

Метод создаёт кампанию:

  • с ручной ставкой для продвижения товаров в поиске и/или рекомендациях
  • с единой ставкой для продвижения товаров одновременно в поиске и рекомендациях

Тип всех созданных этим методом кампаний — 9.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 5 запросов 12 секунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
name
string

Название кампании

nms
Array of integers

Карточки товаров для кампании. Доступные карточки товаров можно получить с помощью метода Карточки товаров для кампаний. Максимум 50 товаров (nm)

bid_type
string
Default: "manual"
Enum: "manual" "unified"

Тип ставки:

  • manual — ручная
  • unified — единая
placement_types
Array of strings
Default: "search"
Items Enum: "search" "recommendations"

Места размещения:

  • search — в поиске
  • recommendations — в рекомендациях

Укажите только для кампании с ручной ставкой

Responses

Request samples

Content type
application/json
{
  • "name": "Телефоны",
  • "nms": [
    ],
  • "bid_type": "manual",
  • "placement_types": [
    ]
}

Response samples

Content type
application/json
1234567

Предметы для кампаний{{ /adv/v1/supplier/subjects }}

Описание метода

Метод возвращает список предметов, которые можно добавить в рекламную кампанию.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
12 секунд 1 запрос 12 секунд 5 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
Example
[
  • {
    }
]

Карточки товаров для кампаний{{ /adv/v2/supplier/nms }}

Описание метода

Метод возвращает список карточек товаров, которые можно добавить в рекламную кампанию. Для получения карточек необходимы ID предметов, также доступных для добавления в кампанию.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 5 запросов 12 секунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json

ID предметов, для которых нужно получить карточки товаров

Array
integer

Responses

Request samples

Content type
application/json
[
  • 123,
  • 456,
  • 765,
  • 321
]

Response samples

Content type
application/json
[
  • {
    }
]

Управление кампаниями

Для доступа к методам используйте токен для категории Продвижение

С помощью методов управления кампаниями вы можете:

  1. Удалить кампанию
  2. Переименовать кампанию
  3. Запустить кампанию
  4. Поставить кампанию на паузу
  5. Завершить кампанию
  6. Изменить ставки в кампаниях
  7. Изменить места размещения в кампаниях с ручной ставкой
  8. Изменить ставки в кампаниях

Удаление кампании{{ /adv/v0/delete }}

Описание метода

Метод удаляет кампании в статусе 4 — готова к запуску.

После удаления кампания некоторое время будет находиться в статусе -1 — кампания в процессе удаления. Полное удаление кампании занимает от 3 до 10 минут.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer

ID кампании

Responses

Response samples

Content type
application/json

Некорректный ID кампании

{
  • "error": "Некорректный ID кампании"
}

Переименование кампании{{ /adv/v0/rename }}

Описание метода

Метод меняет название кампании. Это можно сделать в любой момент существования кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
advertId
required
integer

ID кампании, в которой меняется название

name
required
string

Новое название (максимум 100 символов)

Responses

Request samples

Content type
application/json
{
  • "advertId": 2233344,
  • "name": "newnmame"
}

Response samples

Content type
text/plain
Example
Некорректный ID РК

Запуск кампании{{ /adv/v0/start }}

Описание метода

Метод запускает кампании в статусах 4 — готово к запуску — или 11 — пауза.

Чтобы запустить кампанию со статусом 4, необходимо выполнить два условия:

  1. После создания кампании в кабинете WB. Продвижение нажать кнопку Применить изменения.
  2. Установить бюджет — максимальную сумму затрат на кампанию.

Чтобы запустить кампанию со статусом 11, проверьте ее бюджет. Если бюджета недостаточно, пополните его.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
application/json
Example

Некорректный ID кампании

{
  • "error": "Invalid Advert: invalid advert"
}

Пауза кампании{{ /adv/v0/pause }}

Описание метода

Метод ставит кампании в статусе 9 — активна — на паузу.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
application/json
Example

Некорректный ID кампании

{
  • "error": "Invalid Advert: invalid advert"
}

Завершение кампании{{ /adv/v0/stop }}

Описание метода

Метод завершает кампании в статусах:

  • 4 — готово к запуску
  • 9 — активна
  • 11 — пауза
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
application/json
Example

Некорректный ID кампании

{
  • "error": "Invalid Advert: invalid advert"
}

Изменение ставок{{ /adv/v0/bids }}

Описание метода

Метод меняет ставки карточек товаров по артикулам WB в кампаниях с единой ставкой.

Для кампаний в статусах 4, 9 и 11.

Для изменения ставок в кампаниях с ручной ставкой используйте отдельный метод.

Минимально допустимые ставки вы можете получить в ответе метода получения минимальных ставок для карточек товаров.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (V0AdvertMultibid) <= 20 items

Responses

Request samples

Content type
application/json
{
  • "bids": [
    ]
}

Response samples

Content type
application/json
Example

Повторяется ID кампании.
В .bids[n] указана позиция кампании в массиве запроса bids

{
  • "errors": [
    ],
  • "request_id": "2c991dcab0fe971e8c0321c340a8c7fd",
  • "status": 400,
  • "title": "invalid payload",
  • "type": "Bad Request"
}

Изменение мест размещения в кампаниях с ручной ставкой{{ /adv/v0/auction/placements }}

Описание метода

Метод меняет места размещения в кампаниях с ручной ставкой.

Для кампаний в статусах 4, 9 и 11.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 50 items

Места размещения в кампаниях

Responses

Request samples

Content type
application/json
{
  • "placements": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": "can not deserialize response body",
  • "origin": "camp-api-public-cache",
  • "request_id": "9a929a81ea9dc1601fcc4be81f32c1cb",
  • "status": 400,
  • "title": "invalid payload"
}

Изменение ставок в кампаниях{{ /adv/v0/auction/bids }}

Описание метода

Метод меняет ставки карточек товаров по артикулам WB в кампаниях типа 9 с единой или ручной ставкой.

Для кампаний в статусах 4, 9 и 11.

В запросе укажите место размещения в параметре placement:

  • combined — в поиске и рекомендациях для кампаний с единой ставкой
  • search или recommendations — в поиске или рекомендациях для кампаний с ручной ставкой
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 50 items

Ставки в кампаниях

Responses

Request samples

Content type
application/json
{
  • "bids": [
    ]
}

Response samples

Content type
application/json
{
  • "bids": [
    ]
}

Параметры кампаний

Для доступа к методам используйте токен для категории Продвижение

Методы управления параметрами рекламных кампаний после их запуска:

  1. Управление активностью и установка/удаление фиксированных фраз.
  2. Установка/удаление минус-фраз:
    1. В поиске
    2. Для кампании с единой ставкой
  3. Получение и изменение списка карточек товаров в кампаниях с единой ставкой.
  4. Изменение списка карточек товаров в кампаниях.

Управление активностью фиксированных фраз{{ /adv/v1/search/set-plus }}

Описание метода

Метод делает активными или неактивными фиксированные фразы в кампаниях с ручной ставкой. Фиксированные фразы нужны, чтобы товар отображался в поиске только по определенным поисковым запросам.

Установить или удалить фиксированные фразы можно через отдельный метод.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
500 миллисекунд 1 запрос 500 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

fixed
boolean

Новое состояние (false — сделать неактивными, true — сделать активными)

Responses

Response samples

Content type
application/json
"Неправильный запрос"

Установка/удаление фиксированных фраз{{ /adv/v1/search/set-plus }}

Описание метода

Метод устанавливает и удаляет фиксированные фразы в кампаниях с ручной ставкой. Фиксированные фразы можно выбрать в списке ключевых фраз кампании, который формируется после запуска.

Отправка пустого массива в методе удаляет все фиксированные фразы и отключает активность всех фиксированных фраз кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
500 миллисекунд 1 запрос 500 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
pluse
Array of strings

Список фиксированных фраз (max. 100)

Responses

Request samples

Content type
application/json
{
  • "pluse": [
    ]
}

Response samples

Content type
application/json
[
  • "Фраза 1",
  • "Фраза 2"
]

Установка/удаление минус-фраз в поиске{{ /adv/v1/search/set-excluded }}

Описание метода

Метод устанавливает и удаляет минус-фразы в поиске, в кампаниях с ручной ставкой.

Данные фразы можно выбрать из списка запросов, по которым покупатели находили ваш товар. Список запросов можно получить в статистике по ключевым фразам.
Максимально допустимое количество минус-фраз в кампании — 1000.

Отправка пустого массива удаляет все минус-фразы из поиска из кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 2 запроса 500 миллисекунд 2 запроса
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
excluded
Array of strings

Список минус-фраз, до 1000 фраз

Responses

Request samples

Content type
application/json
{
  • "excluded": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Установка/удаление минус-фраз для кампании с единой ставкой{{ /adv/v1/auto/set-excluded }}

Описание метода

Метод устанавливает и удаляет минус-фразы для кампании с единой ставкой.

Данные фразы можно выбрать из списка запросов, по которым покупатели находили ваш товар. Список запросов можно получить в статистике по ключевым фразам.

Отправка пустого массива удаляет все минус-фразы из кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
6 секунд 1 запрос 6 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
excluded
Array of strings

Список минус-фраз, до 1000 фраз

Responses

Request samples

Content type
application/json
Example

Установка минус-фраз

{
  • "excluded": [
    ]
}

Response samples

Content type
application/json
Example

Некорректный ID кампании

{
  • "error": "Invalid Params: invalid advert ID"
}

Список карточек товаров для кампании с единой ставкой{{ /adv/v1/auto/getnmtoadd }}

Описание метода

Метод формирует список карточек товаров, которые можно добавить в кампанию с единой ставкой.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Responses

Response samples

Content type
application/json
[
  • 1111111111,
  • 2222222222,
  • 3333333333,
  • 4444444444
]

Изменение списка карточек товаров в кампании с единой ставкой{{ /adv/v1/auto/updatenm }}

Описание метода

Метод добавляет и удаляет карточки товаров в кампании с единой ставкой.

Добавить можно только те карточки товаров, которые вернутся в списке карточек товаров для кампании с единой ставкой.
Удалить единственную карточку товара из кампании нельзя.

Проверки по параметру delete не предусмотрено.

Если пришел ответ со статус-кодом 200, а изменений не произошло, проверьте, чтобы запрос соответствовал документации.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 60 запросов 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Request Body schema: application/json
required
add
Array of integers

Карточки товаров, которые необходимо добавить

delete
Array of integers

Карточки товаров, которые необходимо удалить

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "Не найдено"
}

Изменение списка карточек товаров в кампаниях{{ /adv/v0/auction/nms }}

Описание метода

Метод добавляет и удаляет карточки товаров в кампаниях.

Для кампаний в статусах 4, 9 и 11.

Для добавляемых товаров устанавливается текущая минимальная ставка.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 20 items

Карточки товаров в кампаниях

Responses

Request samples

Content type
application/json
{
  • "nms": [
    ]
}

Response samples

Content type
application/json
{
  • "nms": [
    ]
}

Поисковые кластеры

Для доступа к методам используйте токен для категории Продвижение

Поисковые кластеры

Кластер запросов — это сгруппированный список запросов, по которым покупатели ищут товары на WB. В кластер входят: - синонимы - запросы в разном роде: мужской, женский, средний - запросы с опечатками - разные формы слова - близкие по смыслу словосочетания

Например, в кластер футболка мужская войдут также запросы футболка мужкая, футболки мужские с рукавом, футболки мужские и другие похожие словосочетания.

Чтобы получить кластеры, по которым уже были показы, используйте метод статистики поисковых запросов.

Для кампаний с ручной ставкой можно установить или удалить ставки. Ставки индивидуальны для каждого поискового кластера.

Исключения

Установите минус-фразы, чтобы исключить кластеры запросов из кампаний. Товар не будет продвигаться по минус-фразам.

Статистика поисковых кластеров{{ /adv/v0/normquery/stats }}

Описание метода

Метод возвращает статистику по поисковым кластерам за указанный период.
Можно использовать только для кампаний с моделью оплаты cpm — за показы.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 10 запросов 6 секунд 20 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
from
required
string <date>

Дата начала периода

to
required
string <date>

Дата окончания периода

required
Array of objects <= 100 items

Responses

Request samples

Content type
application/json
{
  • "from": "2025-10-07",
  • "to": "2025-10-08",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "stats": [
    ]
}

Список ставок поисковых кластеров{{ /adv/v0/normquery/get-bids }}

Описание метода

Метод возвращает список поисковых кластеров со ставками по:

  • ID кампаний
  • артикулам WB
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 10 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (V0GetNormQueryBidsRequestItem) <= 100 items

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "bids": [
    ]
}

Установить ставки для поисковых кластеров{{ /adv/v0/normquery/bids }}

Описание метода

Метод устанавливает ставки на поисковые кластеры.
Можно использовать только для кампаний с:

  • ручной ставкой
  • моделью оплаты cpm — за показы
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 2 запроса 500 миллисекунд 4 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (V0SetNormQueryBidsRequestItem) <= 100 items

Responses

Request samples

Content type
application/json
{
  • "bids": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": "invalid payment_type value",
  • "origin": "camp-api-public-cache",
  • "request_id": "7e5cb1f106cc6e85b5b29eb2e8815da2",
  • "status": 400,
  • "title": "invalid payload"
}

Удалить ставки поисковых кластеров{{ /adv/v0/normquery/bids }}

Описание метода

Метод удаляет ставки с поисковых кластеров.
Можно использовать только для кампаний с:

  • ручной ставкой
  • моделью оплаты cpm — за показы
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 10 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (V0SetNormQueryBidsRequestItem) <= 100 items

Responses

Request samples

Content type
application/json
{
  • "bids": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": "invalid payment_type value",
  • "origin": "camp-api-public-cache",
  • "request_id": "7e5cb1f106cc6e85b5b29eb2e8815da2",
  • "status": 400,
  • "title": "invalid payload"
}

Список минус-фраз кампаний{{ /adv/v0/normquery/get-minus }}

Описание метода

Метод возвращает список минус-фраз по:

  • ID кампаний
  • артикулам WB
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 10 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (V0GetNormQueryMinusRequestItem) <= 100 items

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Установка и удаление минус-фраз{{ /adv/v0/normquery/set-minus }}

Описание метода

Метод устанавливает и удаляет минус-фразы в кампаниях c:

  • ручной ставкой
  • моделью оплаты cpm — за показы
Отправка пустого массива удаляет все минус-фразы
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 10 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

ID кампании

nm_id
required
integer

Артикул WB

norm_queries
required
Array of strings <= 1000 items

Responses

Request samples

Content type
application/json
{
  • "advert_id": 1825035,
  • "nm_id": 983512347,
  • "norm_queries": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": "invalid payment_type value",
  • "origin": "camp-api-public-cache",
  • "request_id": "7e5cb1f106cc6e85b5b29eb2e8815da2",
  • "status": 400,
  • "title": "invalid payload"
}

Финансы

Для доступа к методам используйте токен для категории Продвижение

Вы можете посмотреть ваш баланс и бюджет ваших рекламных кампаний. Бюджет рекламных кампаний можно пополнить.

Также вы можете узнать историю ваших затрат и пополнений счёта.

Баланс{{ /adv/v1/balance }}

Описание метода

Метод возвращает информацию о:

  • счёте кабинета Продвижения WB. Его пополняет продавец.
  • балансе — максимальной сумме для оплаты кампании по взаиморасчету: удержании средств из будущих продаж. Баланс пополнить нельзя, он рассчитывается автоматически на основе отчётов по продвижению.
  • бонусных начислениях WB.

Информацию о бюджете кампаний можно получить в отдельном методе.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "balance": 11083,
  • "net": 0,
  • "bonus": 15187,
  • "cashbacks": [
    ]
}

Бюджет кампании{{ /adv/v1/budget }}

Описание метода

Метод возвращает информацию о бюджете кампании — максимальной сумме затрат на кампанию. Бюджет кампании можно пополнить.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 4 запроса 250 миллисекунд 4 запроса
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Responses

Response samples

Content type
application/json
{
  • "cash": 0,
  • "netting": 0,
  • "total": 500
}

Пополнение бюджета кампании{{ /adv/v1/budget/deposit }}

Описание метода

Метод пополняет бюджет кампании в статусе 11 — на паузе.
Чтобы запустить кампанию после пополнения бюджета, используйте метод Запуск кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
sum
integer

Общая сумма пополнения бюджета

cashback_sum
integer

Сумма пополнения бюджета промо-бонусами.
Пополнить можно только определённый процент от общей суммы, указанный в поле percent ответа метода получения баланса.
Оставшаяся часть общей суммы спишется с указанного источника пополнения. Пополнить можно только определённый процент от общей суммы, указанный в поле percent ответа метода получения баланса.
Оставшаяся часть общей суммы спишется с указанного источника пополнения.
Списать промо-бонусы можно только для источников пополнения:

  • 0 — счёт
  • 1 — баланс
cashback_percent
integer

Процент от суммы пополнения, который можно пополнить промо-бонусами. Нужно указать значение поля percent из ответа метода получения баланса
Если вы указали cashback_sum, параметр cashback_percent становится обязательным

type
integer

Тип источника пополнения:

  • 0 — Счёт
  • 1 — Баланс
  • 3 — Бонусы
return
boolean

Флаг возврата ответа (true — в ответе вернется обновлённый размер бюджета кампании, false или не указать параметр вообще — не вернётся.)

Responses

Request samples

Content type
application/json
{
  • "sum": 5000,
  • "cashback_sum": 1000,
  • "cashback_percent": 50,
  • "type": 1,
  • "return": true
}

Response samples

Content type
application/json

Ответ при return=true

{
  • "total": 7289
}

Получение истории затрат{{ /adv/v1/upd }}

Описание метода

Метод формирует список фактических затрат на рекламные кампании за заданный период.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
from
required
string <date>
Example: from=2023-07-31

Начало интервала

to
required
string <date>
Example: to=2023-08-02

Конец интервала.
(Минимальный интервал 1 день, максимальный 31)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Получение истории пополнений счёта{{ /adv/v1/payments }}

Описание метода

Метод возвращает историю пополнений счёта WB Продвижение за заданный период.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
from
string <date>
Example: from=2023-07-31

Начало интервала

to
string <date>
Example: to=2023-08-02

Конец интервала.
(Минимальный интервал 1 день, максимальный 31)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Медиа

Для доступа к методам используйте токен для категории Продвижение
Узнать больше о WB Медиа можно в справочном центре

Методы для получения данных кампаний WB Медиа:

  1. Количество медиакампаний
  2. Список медиакампаний
  3. Информация о медиакампании

Количество медиакампаний{{ /adv/v1/count }}

Описание метода

Метод возвращает количество медиакампаний продавца с группировкой по статусам.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 10 запросов 100 миллисекунд 10 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "all": 6,
  • "adverts": {
    }
}

Список медиакампаний{{ /adv/v1/adverts }}

Описание метода

Метод возвращает список всех медиакампаний продавца по их типам и статусам.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 10 запросов 100 миллисекунд 10 запросов
Authorizations:
HeaderApiKey
query Parameters
status
integer
Example: status=1

Статус медиакампании:

  • 1 — черновик
  • 2 — модерация
  • 3 — отклонена (с возможностью вернуть на модерацию)
  • 4 — готова к запуску
  • 5 — запланирована
  • 6 — на показах
  • 7 — завершена
  • 8 — отменена
  • 9 — приостановлена продавцом
  • 10 — пауза по дневному лимиту
  • 11 — пауза
type
integer
Example: type=1

Тип медиакампании:

  • 1 — размещение по дням
  • 2 — размещение по просмотрам
limit
integer
Example: limit=1

Количество кампаний в ответе

offset
integer
Example: offset=1

Смещение относительно первой медиакампании

order
string
Example: order=id

Порядок вывода ответа:

  • create — по времени создания медиакампании
  • id — по ID медиакампании
direction
string
Example: direction=desc

Порядок сортировки:

  • desc — от большего к меньшему
  • asc — от меньшего к большему

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Информация о медиакампании{{ /adv/v1/advert }}

Описание метода

Метод возвращает информацию о кампании WB Медиа. Вместо карточек товаров в медиакампаниях продвигаются рекламные баннеры продавца на сайте и в приложении WB.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 10 запросов 100 миллисекунд 10 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=23569

ID медиакампании

Responses

Response samples

Content type
application/json
{
  • "advertId": 23569,
  • "name": "Реклама денег принеси",
  • "brand": "Plank",
  • "type": 2,
  • "status": 11,
  • "createTime": "2023-07-19T11:13:41.195138+03:00",
  • "extended": {
    },
  • "items": [
    ]
}

Статистика кампаний{{ /adv/v2/fullstats }} Deprecated

Описание метода

Метод будет отключён 30 сентября. Используйте актуальный метод.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array
One of
id
required
integer

ID кампании

dates
required
Array of strings <date> [ items <date > ]

Даты, за которые нужно получить информацию

Responses

Request samples

Content type
application/json
Example

Запрос с датами

[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example

Ответ при запросе с полем date

[
  • {
    }
]

Статистика кампаний{{ /adv/v3/fullstats }}

Описание метода

Метод формирует статистику для кампаний независимо от типа.

Максимальный период в запросе — 31 день.

Для кампаний в статусах 7, 9 и 11.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 1 запрос
Authorizations:
HeaderApiKey
query Parameters
ids
required
string
Example: ids=22161678,28449281,28155229

ID кампаний, максимум 100 значений

beginDate
required
string <date>
Example: beginDate=2025-09-07

Дата начала интервала

endDate
required
string <date>
Example: endDate=2025-09-08

Дата окончания интервала

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Статистика кампании с единой ставкой по кластерам фраз{{ /adv/v2/auto/stat-words }}

Описание метода

Метод формирует кластеры ключевых — то есть, наборы похожих — фраз из поисковой строки, если по ним хотя бы один раз были показаны товары из кампании. В ответе метода также указано количество показов этих товаров.

Информация обновляется каждые 15 минут.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 4 запроса 250 миллисекунд 4 запроса
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
application/json
{
  • "excluded": [
    ],
  • "clusters": [
    ]
}

Статистика кампании c ручной ставкой по ключевым фразам{{ /adv/v1/stat/words }}

Описание метода

Метод формирует статистику кампании c ручной ставкой по ключевым фразам из поисковой строки: количество просмотров товара и затраты по одной ключевой фразе.

Информация обновляется каждые 30 минут.

Тип рекламных кампаний Поиск устарел.
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 4 запроса 250 миллисекунд 4 запроса
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Responses

Response samples

Content type
application/json
{
  • "words": {
    },
  • "stat": [
    ]
}

Статистика по ключевым фразам{{ /adv/v0/stats/keywords }}

Описание метода

Метод формирует статистику по ключевым фразам из поисковой строки: количество просмотров товара и затраты по одной ключевой фразе. Подходит для кампаний c единой и ручной ставкой.

Статистика формируется за каждый день, когда кампания была активна. В одном запросе можно получить данные максимум за 7 дней.
Данные обновляются каждый час.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 4 запроса 250 миллисекунд 4 запроса
Authorizations:
HeaderApiKey
query Parameters
advert_id
required
integer
Example: advert_id=123456789

ID кампании

from
required
string <date>
Example: from=2024-08-10

Начало периода

to
required
string <date>
Example: to=2024-08-12

Конец периода

Responses

Response samples

Content type
application/json
{
  • "keywords": [
    ]
}

Статистика медиакампаний{{ /adv/v1/stats }}

Описание метода

Метод формирует статистику кампаний сервиса WB Медиа. Статистику можно группировать по датам и/или интервалам.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 10 запросов 100 миллисекунд 10 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array ([ 1 .. 100 ] items)
One of
id
required
integer

ID кампании

dates
required
Array of strings <date> [ items <date > ]

Даты, за которые нужно получить информацию

Responses

Request samples

Content type
application/json
Example

Запрос с датами

[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example

Ответ при запросе с интервалами

[
  • {
    }
]

Календарь акций

Для доступа к методам используйте токен для категории Цены и скидки
Узнать больше о календаре акций можно в справочном центре

С помощью этих методов можно получить:

  1. Список акций
  2. Детальную информацию об акциях
  3. Список товаров для участия в акциях

Также можно добавить товар для участия в акции.

Список акций{{ /api/v1/calendar/promotions }}

Описание метода

Метод возвращает список акций в WB с датами и временем проведения.

Лимит запросов на один аккаунт продавца для всех методов категории Календарь акций:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
startDateTime
required
string <RFC3339>
Example: startDateTime=2023-09-01T00:00:00Z

Начало периода, формат YYYY-MM-DDTHH:MM:SSZ

endDateTime
required
string <RFC3339>
Example: endDateTime=2024-08-01T23:59:59Z

Конец периода, формат YYYY-MM-DDTHH:MM:SSZ

allPromo
required
boolean
Default: false

Показать акции:

  • false — доступные для участия
  • true — все акции
limit
integer <uint> [ 1 .. 1000 ]
Example: limit=10

Количество запрашиваемых акций

offset
integer <uint> >= 0
Example: offset=0

После какого элемента выдавать данные

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Детальная информация об акциях{{ /api/v1/calendar/promotions/details }}

Описание метода

Метод возвращает подробную информацию об акции по ID.

Лимит запросов на один аккаунт продавца для всех методов категории Календарь акций:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
promotionIDs
required
string [ 1 .. 100 ] items unique
Example: promotionIDs=1&promotionIDs=3&promotionIDs=64

ID акций, по которым нужно вернуть информацию

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Список товаров для участия в акции{{ /api/v1/calendar/promotions/nomenclatures }}

Описание метода

Метод формирует список товаров, подходящих для участия в акции. Эти товары можно добавить в акцию с помощью отдельного метода.

Данный метод неприменим для автоакций.
Лимит запросов на один аккаунт продавца для всех методов категории Календарь акций:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
promotionID
required
integer
Example: promotionID=1

ID акции

inAction
required
boolean
Default: false
Example: inAction=true

Участвует в акции:

  • true — да
  • false — нет
limit
integer <uint> [ 1 .. 1000 ]
Example: limit=10

Количество запрашиваемых товаров

offset
integer <uint> >= 0
Example: offset=0

После какого элемента выдавать данные

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Добавить товар в акцию{{ /api/v1/calendar/promotions/upload }}

Описание метода

Метод создаёт задание на загрузку товара в акцию.
Состояние загрузки можно проверить с помощью отдельных методов.

Данный метод неприменим для автоакций.
Лимит запросов на один аккаунт продавца для всех методов категории Календарь акций:
Период Лимит Интервал Всплеск
6 секунд 10 запросов 600 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
object

Данные запроса

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}
Документация — WB API
Поиск

Общение с покупателями (communication)

Узнать больше об общении с покупателями можно в справочном центре

С помощью методов общения с покупателями вы можете работать с:

  1. Вопросами и отзывами покупателей
  2. Шаблонами ответов на вопросы и отзывы
  3. Чатами с покупателями
  4. Заявками покупателей на возврат

Общение с покупателями

Узнать больше об общении с покупателями можно в справочном центре

С помощью методов общения с покупателями вы можете работать с:

  1. Вопросами и отзывами покупателей
  2. Шаблонами ответов на вопросы и отзывы
  3. Чатами с покупателями
  4. Заявками покупателей на возврат

Вопросы

Для доступа к методам используйте токен для категории Вопросы и отзывы
Узнать больше о вопросах можно в справочном центре

Методы для получения вопросов:

  1. Непросмотренные отзывы и вопросы
  2. Неотвеченные вопросы
  3. Количество вопросов
  4. Список вопросов

Вы можете получить один вопрос по его ID и работать с полученными вопросами.

Непросмотренные отзывы и вопросы{{ /api/v1/new-feedbacks-questions }}

Описание метода

Метод проверяет наличие непросмотренных вопросов и отзывов от покупателей. Если у продавца есть непросмотренные вопросы или отзывы, возвращает true.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Неотвеченные вопросы{{ /api/v1/questions/count-unanswered }}

Описание метода

Метод возвращает общее количество неотвеченных вопросов и количество неотвеченных вопросов за сегодня.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Количество вопросов{{ /api/v1/questions/count }}

Описание метода

Метод возвращает количество отвеченных или неотвеченных вопросов за заданный период.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
query Parameters
dateFrom
integer
Example: dateFrom=1688465092

Дата начала периода в формате Unix timestamp

dateTo
integer
Example: dateTo=1688465092

Дата конца периода в формате Unix timestamp

isAnswered
boolean
Example: isAnswered=false

Есть ли ответ на вопрос:

  • true — да, по умолчанию
  • false — нет

Responses

Response samples

Content type
application/json
{
  • "data": 77,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Список вопросов{{ /api/v1/questions }}

Описание метода

Метод возвращает список вопросов по заданным фильтрам. Вы можете:

  • получить данные отвеченных и неотвеченных вопросов
  • сортировать вопросы по дате
  • настроить пагинацию и количество вопросов в ответе
Можно получить максимум 10 000 вопросов в одном ответе
Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
query Parameters
isAnswered
required
boolean

Есть ли ответ на вопрос:

  • true — да, по умолчанию
  • false — нет
nmId
integer

Артикул WB

take
required
integer

Количество запрашиваемых вопросов (максимально допустимое значение для параметра - 10 000, при этом сумма значений параметров take и skip не должна превышать 10 000)

skip
required
integer

Количество вопросов для пропуска (максимально допустимое значение для параметра - 10 000, при этом сумма значений параметров take и skip не должна превышать 10 000)

order
string

Сортировка вопросов по дате (dateAsc/dateDesc)

dateFrom
integer
Example: dateFrom=1688465092

Дата начала периода в формате Unix timestamp

dateTo
integer
Example: dateTo=1688465092

Дата конца периода в формате Unix timestamp

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Работа с вопросами{{ /api/v1/questions }}

Описание метода

В зависимости от тела запроса, метод позволяет:

  • отметить вопрос как просмотренный
  • отклонить вопрос
  • ответить на вопрос или отредактировать ответ
Отредактировать ответ на вопрос можно 1 раз в течение 60 дней после отправки ответа
Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
One of
id
required
string

Id вопроса

wasViewed
required
boolean

Просмотрен ли вопрос

Responses

Request samples

Content type
application/json
Example

Просмотреть вопрос

{
  • "id": "n5um6IUBQOOSTxXoo0gV",
  • "wasViewed": true
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Получить вопрос по ID{{ /api/v1/question }}

Описание метода

Метод возвращает данные вопроса по его ID. Далее вы можете работать с этим вопросом.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
string
Example: id=ljAVapEBL38RyMdRln61

ID вопроса

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Отзывы

Для доступа к методам используйте токен для категории Вопросы и отзывы
Узнать больше об отзывах можно в справочном центре

Методы для получения отзывов:

  1. Непросмотренные отзывы и вопросы
  2. Необработанные отзывы
  3. Количество отзывов
  4. Список отзывов
  5. Список архивных отзывов

Вы можете получить товар один отзыв по его ID и работать с полученными вопросами через методы:

  1. Ответить на отзыв
  2. Отредактировать ответ на отзыв
  3. Возврат товара по ID отзыва

Необработанные отзывы{{ /api/v1/feedbacks/count-unanswered }}

Описание метода

Метод возвращает:

  • количество необработанных отзывов за сегодня и за всё время
  • среднюю оценку всех отзывов
Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Количество отзывов{{ /api/v1/feedbacks/count }}

Описание метода

Метод возвращает количество обработанных или необработанных отзывов за заданный период.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
query Parameters
dateFrom
integer
Example: dateFrom=1688465092

Дата начала периода в формате Unix timestamp

dateTo
integer
Example: dateTo=1688465092

Дата конца периода в формате Unix timestamp

isAnswered
boolean
Example: isAnswered=false

Обработан ли отзыв:

  • true — да, по умолчанию
  • false — нет

Responses

Response samples

Content type
application/json
{
  • "data": 724583,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Список отзывов{{ /api/v1/feedbacks }}

Описание метода

Метод возвращает список отзывов по заданным фильтрам. Вы можете:

  • получить данные обработанных и необработанных отзывов
  • сортировать отзывы по дате
  • настроить пагинацию и количество отзывов в ответе
Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
query Parameters
isAnswered
required
boolean
Example: isAnswered=false

Обработан ли отзыв:

  • true — да, по умолчанию
  • false — нет
nmId
integer
Example: nmId=5870243

Артикул WB

take
required
integer
Example: take=1

Количество отзывов (max. 5 000)

skip
required
integer
Example: skip=0

Количество отзывов для пропуска (max. 199990)

order
string
Enum: "dateAsc" "dateDesc"

Сортировка отзывов по дате (dateAsc/dateDesc)

dateFrom
integer
Example: dateFrom=1688465092

Дата начала периода в формате Unix timestamp

dateTo
integer
Example: dateTo=1688465092

Дата конца периода в формате Unix timestamp

Responses

Response samples

Content type
application/json
{}

Получить списки причин жалоб на отзыв и проблем с товаром{{ /api/v1/supplier-valuations }} Deprecated

Описание метода

Данный метод устарел. Он будет удалён 8 декабря

Authorizations:
HeaderApiKey
header Parameters
X-Locale
string
Example: ru

Выбор языка значений полей ответа (ru - русский, en - английский, zh - китайский)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Пожаловаться на отзыв, сообщить о проблеме с товаром{{ /api/v1/feedbacks/actions }} Deprecated

Описание метода

Данный метод устарел. Он будет удалён 8 декабря

Authorizations:
HeaderApiKey
Request Body schema: application/json
id
required
string
supplierFeedbackValuation
integer

Причина жалобы на отзыв
Доступные причины указаны в таблице сопоставления причин жалоб в API и на портале продавцов, в столбце Причины в API. Таблицу вы можете найти в описании метода получения списков причин жалоб и проблем с товаром

supplierProductValuation
integer

Описание проблемы товара
Можно получить из поля productValuations, метод получения списков причин жалоб и проблем с товаром

Responses

Request samples

Content type
application/json
{
  • "id": "J2FMRjUj6hwvwCElqssz",
  • "supplierFeedbackValuation": 1,
  • "supplierProductValuation": 1
}

Response samples

Content type
application/json
Example

Не указан заголовок Content-Type

{
  • "title": "bad request",
  • "requestId": "e6c4100223db8bf5818b2e5f12705891",
  • "origin": "fbapi",
  • "detail": "content-type header not specified"
}

Ответить на отзыв{{ /api/v1/feedbacks/answer }}

Описание метода

Метод позволяет ответить на отзыв покупателя.

ID отзыва не валидируется. Если в запросе вы передали некорректный ID, вы не получите ошибку.
Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
id
required
string

ID отзыва

text
required
string [ 2 .. 5000 ]

Текст ответа

Responses

Request samples

Content type
application/json
{
  • "id": "J2FMRjUj6hwvwCElqssz",
  • "text": "Спасибо за Ваш отзыв!"
}

Response samples

Content type
application/json
Example

Не указан заголовок Content-Type

{
  • "title": "bad request",
  • "requestId": "e6c4100223db8bf5818b2e5f12705891",
  • "origin": "fbapi",
  • "detail": "content-type header not specified"
}

Отредактировать ответ на отзыв{{ /api/v1/feedbacks/answer }}

Описание метода

Метод позволяет отредактировать уже отправленный ответ на отзыв покупателя.

Отредактировать ответ можно только один раз в течение 60 дней c момента отправки.

ID отзыва не валидируется. Если в запросе вы передали некорректный ID, вы не получите ошибку.
Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
id
required
string

ID отзыва

text
required
string [ 2 .. 5000 ]

Текст ответа

Responses

Request samples

Content type
application/json
{
  • "id": "J2FMRjUj6hwvwCElqssz",
  • "text": "Спасибо за Ваш отзыв, он очень важен для нас!"
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Возврат товара по ID отзыва{{ /api/v1/feedbacks/order/return }}

Описание метода

Метод запрашивает возврат товара, по которому оставлен отзыв.

Возврат доступен для отзывов с полем "isAbleReturnProductOrders": true.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
feedbackId
string

ID отзыва

Responses

Request samples

Content type
application/json
{
  • "feedbackId": "absdfgerrrfff1234"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "error": true,
  • "errorText": "string",
  • "additionalErrors": [
    ]
}

Получить отзыв по ID{{ /api/v1/feedback }}

Описание метода

Метод возвращает данные отзыва по его ID.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
string
Example: id=G7Y9Y1kBAtKOitoBT_lV

ID отзыва

Responses

Response samples

Content type
application/json
{}

Список архивных отзывов{{ /api/v1/feedbacks/archive }}

Описание метода

Метод возвращает список архивных отзывов.

Отзыв становится архивным, если:

  • на отзыв получен ответ
  • на отзыв не получен ответ в течение 30 дней
  • в отзыве нет текста и фото
Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
query Parameters
nmId
integer
Example: nmId=14917842

Артикул WB

take
required
integer
Example: take=1

Количество отзывов (max. 5 000)

skip
required
integer
Example: skip=0

Количество отзывов для пропуска

order
string
Enum: "dateAsc" "dateDesc"

Сортировка отзывов по дате (dateAsc/dateDesc)

Responses

Response samples

Content type
application/json
{}

Шаблоны ответов

Для доступа к методам используйте токен для категории Вопросы и отзывы
Узнать больше о шаблонах ответов на вопросы и отзывы можно в справочном центре

Методы управления шаблонами шаблонами ответов на вопросы и отзывы:

  1. Получение шаблонов ответов
  2. Создание
  3. Редактирование
  4. Удаление
Большинство ответов не дифференцируются по статус-коду.
На некорректный запрос вы получите ответ со статус-кодом 200 и описанием ошибки.

Получить шаблоны ответов на вопросы и отзывы{{ /api/v1/templates }} Deprecated

Описание метода

Метод возвращает список шаблонов ответов на вопросы и отзывы покупателей.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
query Parameters
templateType
required
integer
Example: templateType=1

1 - шаблоны для отзывов
2 - шаблоны для вопросов

Responses

Response samples

Content type
application/json
Example

Успешно

{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Создать шаблон{{ /api/v1/templates }} Deprecated

Описание метода

Метод добавляет шаблон ответа на вопрос или отзыв покупателя.

Можно создать максимум 20 шаблонов: 10 для отзывов и 10 для вопросов. В тексте шаблона можно использовать любые символы.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
name
required
string

Название шаблона, от 1 до 100 символов

templateType
required
integer

Тип шаблона
1 - шаблон для отзывов
2 - шаблон для вопросов

text
required
string

Текст шаблона (от 2 до 1000 символов)

Responses

Request samples

Content type
application/json
{
  • "name": "name",
  • "templateType": 1,
  • "text": "text"
}

Response samples

Content type
application/json
Example

Успешно

{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Редактировать шаблон{{ /api/v1/templates }} Deprecated

Описание метода

Метод редактирует шаблон ответа на вопрос или отзыв покупателя.

В тексте шаблона можно использовать любые символы.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
name
required
string

Название шаблона, от 1 до 100 символов

templateID
required
string

ID шаблона

text
required
string

Текст шаблона (от 2 до 1000 символов)

Responses

Request samples

Content type
application/json
{
  • "name": "newname",
  • "templateID": "1234fhbf34ew2",
  • "text": "newtext"
}

Response samples

Content type
application/json
Example

Успешно

{
  • "data": true,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Удалить шаблон{{ /api/v1/templates }} Deprecated

Описание метода

Метод редактирует шаблон ответа на вопрос или отзыв покупателя.

Лимит запросов на один аккаунт продавца для всех методов категории Вопросы и отзывы:
Период Лимит Интервал Всплеск
1 секунда 3 запроса 333 миллисекунды 6 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
templateID
required
string

ID шаблона (max. 1)

Responses

Request samples

Content type
application/json
{
  • "templateID": "1234fhbf34ew2"
}

Response samples

Content type
application/json
Example

Успешно

{
  • "data": true,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Чат с покупателями

Для доступа к методам используйте токен для категории Чат с покупателями
Узнать больше о чате с покупателями можно в справочном центре

Чат позволяет продавцам и покупателям общаться напрямую.
Покупатели могут обращаться с вопросами по товарам или претензиями. Рекомендуем отвечать на сообщения в чате в течение 10 дней.



Чат всегда начинает покупатель. В одном чате можно общаться только с одним покупателем.

Обработка заявок на возврат товара доступна только в веб-версии чатов с покупателями.

Работа с чатами:

  1. Получите список чатов. Сохраните ID чатов в своей базе данных — это позволит обновлять информацию о чатах при получении событий.
  2. Получите события чатов: сообщения. У новых чатов значение поля isNewChat будет true.
  3. Отправляйте сообщения в чат

Список чатов{{ /api/v1/seller/chats }}

Описание метода

Метод возвращает список всех чатов продавца. По этим данным можно получить события чатов или отправить сообщение покупателю.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 10 запросов 1 секунда 10 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "errors": null
}

События чатов{{ /api/v1/seller/events }}

Описание метода

Метод возвращает список событий всех чатов с покупателями.

Чтобы получить все события:

  1. Сделайте первый запрос без параметра next.
  2. Повторяйте запрос со значением параметра next из ответа на предыдущий запрос, пока totalEvents не станет равным 0. Это будет означать, что вы получили все события.
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 10 запросов 1 секунда 10 запросов
Authorizations:
HeaderApiKey
query Parameters
next
integer

Пагинатор. С какого момента получить следующий пакет данных.
Формат Unix timestamp с миллисекундами

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "errors": null
}

Отправить сообщение{{ /api/v1/seller/message }}

Описание метода

Метод отправляет сообщения в чат с покупателем.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 10 запросов 1 секунда 10 запросов
Authorizations:
HeaderApiKey
Request Body schema: multipart/form-data
required
replySign
required
string <= 255 characters

Подпись чата. Можно получить из информации по чату или данных события, если в событии есть поле "isNewChat": true.

message
string <= 1000 characters

Текст сообщения. Максимум 1000 символов.

file
Array of strings <binary> [ items <binary > ]

Файлы, формат JPEG, PDF или PNG, максимальный размер — 5 Мб каждый. Максимальный суммарный размер файлов — 30 Мб.

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "errors": [ ]
}

Получить файл из сообщения{{ /api/v1/seller/download/{id} }}

Описание метода

Метод возвращает файл или изображение из сообщения по его ID.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 10 запросов 1 секунда 10 запросов
Authorizations:
HeaderApiKey
path Parameters
id
required
string

ID файла, см. значение поля downloadID в методе События чатов

Responses

Response samples

Content type
application/json

Недействительный ID файла

{
  • "status": 400,
  • "title": "invalid fileID",
  • "origin": "proxy-chats",
  • "detail": "invalid fileID",
  • "requestId": "62f59a4ce21064f20b1bbc28c85f38d8",
  • "error": "invalid fileID"
}

Возвраты покупателями

Для доступа к методам используйте токен для категории Возвраты покупателями
Узнать больше о возвратах покупателями можно в справочном центре

С помощью этих методов вы можете:

  1. Отслеживать заявки покупателей на возврат
  2. Отвечать на заявки

Заявки покупателей на возврат{{ /api/v1/claims }}

Описание метода

Метод возвращает заявки покупателей на возврат товаров за последние 14 дней. Вы можете отвечать на эти заявки.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 20 запросов 3 секунды 10 запросов
Authorizations:
HeaderApiKey
query Parameters
is_archive
required
boolean
Example: is_archive=true

Состояние заявки:

  • false — на рассмотрении
  • true — в архиве
id
string <UUID>
Example: id=fe3e9337-e9f9-423c-8930-946a8ebef80

ID заявки

limit
integer <uint> [ 1 .. 200 ]
Example: limit=50

Количество заявок в ответе. По умолчанию 50

offset
integer <uint> >= 0
Example: offset=0

После какого элемента выдавать данные. По умолчанию 0

nm_id
integer
Example: nm_id=196320101

Артикул WB

Responses

Response samples

Content type
application/json
{
  • "claims": [
    ],
  • "total": 31
}

Ответ на заявку покупателя{{ /api/v1/claim }}

Описание метода

Метод отправляет ответ на заявку покупателя на возврат товаров.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 20 запросов 3 секунды 10 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required

Ответ на заявку

id
required
string <UUID>

ID заявки

action
required
string

Действие с заявкой.
Используйте одно из значений массива actions — ответа метода получения заявок

comment
string [ 10 .. 1000 ] characters

Комментарий.
Применимо только при "action":"rejectcustom" или "action":"approvecc1". При "action":"rejectcustom" параметр обязателен

Responses

Request samples

Content type
application/json
{
  • "id": "fe3e9337-e9f9-423c-8930-946a8ebef80",
  • "action": "rejectcustom",
  • "comment": "Фото не имеет отношения к товару в заявке"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "title": "Validation error",
  • "detail": "Input model is not valid; Details: The Action field is required.",
  • "requestId": "0HN3PI6JUGFSL:00000004"
}
Документация — WB API
Поиск

Тарифы (tariffs)

Узнать больше о комиссиях и тарифах можно в справочном центре

В разделе описаны методы получения:

  1. Комиссий
  2. Коэффициентов складов
  3. Тарифов на возврат товаров продавцу

Тарифы

Узнать больше о комиссиях и тарифах можно в справочном центре

В разделе описаны методы получения:

  1. Комиссий
  2. Коэффициентов складов
  3. Тарифов на возврат товаров продавцу

Комиссии

Комиссии можно получить с токеном любой категории
Узнать больше о комиссиях можно в справочном центре

Метод получения комиссии по категориям товаров.

Комиссия по категориям товаров{{ /api/v1/tariffs/commission }}

Описание метода

Метод возвращает данные о комиссии WB по родительским категориям товаров согласно модели продаж.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 2 запроса
Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=ru

Язык полей ответа parentName и subjectName:

  • ru — русский
  • en — английский
  • zh — китайский

Responses

Response samples

Content type
application/json
Example

Комиссия

{
  • "report": [
    ]
}

Коэффициенты складов

Коэффициенты складов можно получить с токеном любой категории

Предоставляются данные по текущим и архивным тарифам для:

Тарифы для коробов{{ /api/v1/tariffs/box }}

Описание метода

Для товаров, которые поставляются на склад в коробах, метод возвращает тарифы на остаток:

  • доставка со склада или пункта приёма до покупателя
  • доставка от покупателя до пункта приёма
  • хранение на складе WB
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 60 запросов 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
date
required
string

Дата в формате ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "response": {
    }
}

Тарифы для монопаллет{{ /api/v1/tariffs/pallet }}

Описание метода

Для товаров, которые поставляются на склад WB на монопаллетах, метод возвращает стоимость:

  • доставки со склада до покупателя
  • доставки от покупателя до склада
  • хранения на складе WB
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 60 запросов 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
date
required
string

Дата в формате ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "response": {
    }
}

Стоимость возврата продавцу

Стоимость возврата продавцу можно получить с токеном любой категории
Узнать больше о возвратах продавцу можно в справочном центре

Метод получения тарифов на возврат.

Тарифы на возврат{{ /api/v1/tariffs/return }}

Описание метода

Метод возвращает тарифы:

  • на перевозку товаров со склада WB или из пункта приёма до продавца
  • на обратную перевозку возвратов, которые не забрал продавец
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 60 запросов 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
date
required
string

Дата в формате ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "response": {
    }
}
Документация — WB API
Поиск

Аналитика и данные (analytics)

Узнать больше об аналитике и данных можно в справочном центре

В разделе описаны методы получения:

  1. Воронки продаж
  2. Поисковых запросов по вашим товарам
  3. Истории остатков
  4. Аналитики продавца в формате CSV

Аналитика и данные

Узнать больше об аналитике и данных можно в справочном центре

В разделе описаны методы получения:

  1. Воронки продаж
  2. Поисковых запросов по вашим товарам
  3. Истории остатков
  4. Аналитики продавца в формате CSV

Воронка продаж

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об аналитике воронки продаж можно в справочном центре

Методы получения статистики:

  1. Карточек товаров за период
  2. Карточек товаров по дням
  3. Групп карточек товаров по дням
Таймзоны представлены в формате IANA, актуальный список можно посмотреть здесь

Статистика карточек товаров за период{{ /api/analytics/v3/sales-funnel/products }}

Описание метода

Метод формирует отчёт о товарах, сравнивая ключевые показатели — например, добавления в корзину, заказы и переходы в карточку товара — за текущий период с аналогичным прошлым.

Параметры brandNames,subjectIds, tagIds, nmIds могут быть пустыми [], тогда в ответе возвращаются все карточки продавца.

Если вы указали несколько параметров, в ответе будут карточки, в которых есть одновременно все эти параметры. Если карточки не подходят по параметрам запроса, вернётся пустой ответ [].

Можно получить отчёт максимум за последние 365 дней.

В данных предыдущего периода:

  • Данные в pastPeriod указаны за такой же период, что и в selectedPeriod
  • Если дата начала pastPeriod раньше, чем год назад от текущей даты, она будет приведена к виду: pastPeriod.start = текущая дата — 365 дней

Можно использовать пагинацию.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Запрашиваемый период

object

Период для сравнения

nmIds
Array of integers <uint64> [ 0 .. 1000 ] items [ items <uint64 > ]

Артикулы WB, по которым нужно составить отчёт. Оставьте пустым, чтобы получить отчёт обо всех товарах

brandNames
Array of strings

Список брендов для фильтрации

subjectIds
Array of integers <uint64> [ items <uint64 > ]

Список ID предметов для фильтрации

tagIds
Array of integers <uint64> [ items <uint64 > ]

Список ID ярлыков для фильтрации

skipDeletedNm
boolean

Скрыть удалённые карточки товаров

object (OrderBy)

Параметры сортировки

limit
integer <uint32>
Default: 50

Количество карточек товара в ответе

offset
integer <uint32>
Default: 0

Сколько элементов пропустить. Например, для значения 10 ответ начнется с 11 элемента

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "brandNames": [
    ],
  • "subjectIds": [
    ],
  • "tagIds": [
    ],
  • "skipDeletedNm": false,
  • "orderBy": {
    },
  • "limit": 50,
  • "offset": 10
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Статистика карточек товаров по дням{{ /api/analytics/v3/sales-funnel/products/history }}

Описание метода

Метод возвращает статистику карточек товаров по дням или неделям. Доступны данные по добавлениям в корзину, заказам, переходам в карточку товара и так далее.

Можно получить данные максимум за последнюю неделю.

Чтобы получать отчёты за период до года, используйте методы Аналитика продавца CSV. Эти методы доступны только с подпиской на расширенную аналитику Джем
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Запрашиваемый период

nmIds
required
Array of integers <uint64> [ 1 .. 20 ] items [ items <uint64 > ]

Артикулы WB, по которым нужно составить отчёт

skipDeletedNm
boolean

Скрыть удалённые карточки товаров

aggregationLevel
string (Level)
Default: "day"
Enum: "day" "week"

Тип агрегации. Если не указано, то по умолчанию используется агрегация по дням.
Доступные уровни агрегации day, week

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "nmIds": [
    ],
  • "skipDeletedNm": true,
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
[
  • {
    }
]

Статистика групп карточек товаров по дням{{ /api/analytics/v3/sales-funnel/grouped/history }}

Описание метода

Метод возвращает статистику карточек товаров по дням или неделям. Карточки товаров сгруппированы по предметам, брендам и ярлыкам. Доступны данные по добавлениям в корзину, заказам, переходам в карточку товара и так далее.

Параметры brandNames, subjectIds, tagIds могут быть пустыми [], тогда группировка происходит по всем карточкам продавца.

Произведение количества предметов, брендов, ярлыков в запросе может быть не больше 16. Например, 4 бренда и 4 предмета или 2 предмета, 2 ярлыка и 4 бренда.

Можно получить данные максимум за последнюю неделю.

Чтобы получать отчёты за период до года, используйте методы Аналитика продавца CSV. Эти методы доступны только с подпиской на расширенную аналитику Джем
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Запрашиваемый период

brandNames
Array of strings

Список брендов для фильтрации

subjectIds
Array of integers <uint64> [ items <uint64 > ]

Список ID предметов для фильтрации

tagIds
Array of integers <uint64> [ items <uint64 > ]

Список ID ярлыков для фильтрации

skipDeletedNm
boolean

Скрыть удалённые карточки товаров

aggregationLevel
string (Level)
Default: "day"
Enum: "day" "week"

Тип агрегации. Если не указано, то по умолчанию используется агрегация по дням.
Доступные уровни агрегации day, week

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "brandNames": [
    ],
  • "subjectIds": [
    ],
  • "tagIds": [
    ],
  • "skipDeletedNm": false,
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Статистика карточек товаров за период{{ /api/v2/nm-report/detail }} Deprecated

Описание метода

Данный метод устарел. Он будет удалён 9 декабря

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
brandNames
Array of strings

Бренды

objectIDs
Array of integers <int32> [ items <int32 > ]

ID предметов

tagIDs
Array of integers <int32> [ items <int32 > ]

ID ярлыков

nmIDs
Array of integers <int32> [ items <int32 > ]

Артикулы WB

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

required
object

Период

object

Параметры сортировки. Если не указано, то по умолчанию используется значение "openCard" и сортировка по убыванию.

Все виды сортировки field:

  • openCard — по открытию карточки (переход на страницу товара)
  • addToCart — по добавлениям в корзину
  • orders — по кол-ву заказов
  • avgRubPrice — по средней цене в рублях
  • ordersSumRub — по сумме заказов в рублях
  • stockMpQty — по кол-ву остатков маркетплейса шт.
  • stockWbQty — по кол-ву остатков на складе шт.
  • cancelSumRub — сумме возвратов в рублях
  • cancelCount — по кол-ву возвратов
  • buyoutCount — по кол-ву выкупов
  • buyoutSumRub — по сумме выкупов
page
required
integer <int32>

Страница

Responses

Request samples

Content type
application/json
{
  • "brandNames": [
    ],
  • "objectIDs": [
    ],
  • "tagIDs": [
    ],
  • "nmIDs": [
    ],
  • "timezone": "Europe/Moscow",
  • "period": {
    },
  • "orderBy": {
    },
  • "page": 1
}

Response samples

Content type
application/json
Example
{
  • "data": {
    },
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Статистика карточек товаров по дням{{ /api/v2/nm-report/detail/history }} Deprecated

Описание метода

Данный метод устарел. Он будет удалён 9 декабря

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
required
Array of integers <int32> [ items <int32 > ]

Артикул WB (максимум 20)

required
object

Период

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

aggregationLevel
string

Тип агрегации. Если не указано, то по умолчанию используется агрегация по дням.
Доступные уровни агрегации day, week

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "period": {
    },
  • "timezone": "Europe/Moscow",
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Статистика групп карточек товаров по дням{{ /api/v2/nm-report/grouped/history }} Deprecated

Описание метода

Данный метод устарел. Он будет удалён 9 декабря

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
objectIDs
Array of integers <int32> [ items <int32 > ]

ID предметов

brandNames
Array of strings

Бренды

tagIDs
Array of integers <int32> [ items <int32 > ]

ID ярлыков

required
object

Период

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

aggregationLevel
string

Тип агрегации. Если не указано, то по умолчанию используется агрегация по дням.
Доступные уровни агрегации day, week

Responses

Request samples

Content type
application/json
{
  • "objectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "period": {
    },
  • "timezone": "Europe/Moscow",
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Поисковые запросы по вашим товарам

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об аналитике поисковых запросов можно в справочном центре

Методы получения отчёта по поисковым запросам по вашим товарам, в частности:

  1. Основной страницы
  2. Дополнительных данных к основной странице с пагинацией по группам или пагинацией по товарам в группе
  3. Поисковых запросов по товару
  4. Заказов и позиций по поисковым запросам товара
Вы можете использовать эти методы только с подпиской Джем.

Основная страница{{ /api/v2/search-report/report }}

Описание метода

Метод формирует набор данных для основной страницы отчёта по поисковым запросам с:

  • общей информацией
  • позициями товаров
  • данными по видимости и переходам в карточку
  • данными для таблицы по группам

Для получения дополнительных данных в таблице используйте отдельный запрос для:

Дополнительный параметр выбора списка товаров в таблице:

  • positionCluster — средняя позиция в поиске

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Текущий период

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
Array of integers <int32> [ items <int32 > ]

Список артикулов WB для фильтрации

subjectIds
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIds
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

positionCluster
required
string (PositionCluster)
Enum: "all" "firstHundred" "secondHundred" "below"

Товары с какой средней позицией в поиске показывать в отчёте:

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
required
object (OrderBy)

Параметры сортировки

includeSubstitutedSKUs
boolean
Default: true

Показать данные по прямым запросам с подменным артикулом

includeSearchTexts
boolean
Default: true

Показать данные по поисковым запросам без учёта подменного артикула

limit
required
integer <uint32> <= 1000

Количество групп товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "positionCluster": "all",
  • "orderBy": {
    },
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "limit": 130,
  • "offset": 50
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Пагинация по группам{{ /api/v2/search-report/table/groups }}

Описание метода

Метод формирует дополнительные данные к основному отчёту с пагинацией по группам. Пагинация возможна только при наличии фильтра по бренду, предмету или ярлыку.

Дополнительный параметр выбора списка товаров в таблице:

  • positionCluster — средняя позиция в поиске

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Текущий период

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
Array of integers <int32> [ items <int32 > ]

Список артикулов WB для фильтрации

subjectIds
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIds
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

required
object (OrderByGrTe)

Параметры сортировки

positionCluster
required
string (PositionCluster)
Enum: "all" "firstHundred" "secondHundred" "below"

Товары с какой средней позицией в поиске показывать в отчёте:

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
includeSubstitutedSKUs
boolean
Default: true

Показать данные по прямым запросам с подменным артикулом

includeSearchTexts
boolean
Default: true

Показать данные по поисковым запросам без учёта подменного артикула

limit
required
integer <uint32> <= 1000

Количество групп товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "orderBy": {
    },
  • "positionCluster": "all",
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "limit": 130,
  • "offset": 50
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Пагинация по товарам в группе{{ /api/v2/search-report/table/details }}

Описание метода

Метод формирует дополнительные данные к основному отчёту с пагинацией по товарам в группе. Пагинация возможна вне зависимости от наличия фильтров.

Фильтры для пагинации по товарам в группе или без фильтров:

  • кортеж subjectId,brandName,tagId — фильтр для группы
  • nmIds — фильтр по карточке товара

Дополнительный параметр выбора списка товаров:

  • positionCluster — средняя позиция в поиске

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Текущий период

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

subjectId
integer <int32>

ID предмета

brandName
string

Название товара

tagId
integer <int64>

ID ярлыка

nmIds
Array of integers <uint64> <= 50 items [ items <uint64 > ]

Список артикулов WB

required
object (OrderBy)

Параметры сортировки

positionCluster
required
string
Enum: "all" "firstHundred" "secondHundred" "below"

Товары с какой средней позицией в поиске показывать в отчёте:

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
includeSubstitutedSKUs
boolean
Default: true

Показать данные по прямым запросам с подменным артикулом

includeSearchTexts
boolean
Default: true

Показать данные по поисковым запросам без учёта подменного артикула

limit
required
integer <uint32> <= 1000

Количество товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "subjectId": 123,
  • "brandName": "Apple",
  • "tagId": 45,
  • "nmIds": [
    ],
  • "orderBy": {
    },
  • "positionCluster": "all",
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "limit": 150,
  • "offset": 100
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Поисковые запросы по товару{{ /api/v2/search-report/product/search-texts }}

Описание метода

Метод формирует топ поисковых запросов по товару.

Параметры выбора поисковых запросов:

  • limit — количество запросов, максимум 30 (для тарифа Продвинутый — 100)
  • topOrderBy — способ выбора топа запросов

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Текущий период

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
required
Array of integers <uint64> <= 50 items [ items <uint64 > ]

Список артикулов WB

topOrderBy
required
string
Enum: "openCard" "addToCart" "openToCart" "orders" "cartToOrder"

Фильтрация по поисковым запросам, по которым больше всего:

  • openCard — перешли в карточку
  • addToCart — добавили в корзину
  • openToCart — конверсия в корзину
  • orders — заказали товаров
  • cartToOrder — конверсия в заказ
includeSubstitutedSKUs
boolean
Default: true

Показать данные по прямым запросам с подменным артикулом

includeSearchTexts
boolean
Default: true

Показать данные по поисковым запросам без учёта подменного артикула

required
object (OrderByGrTe)

Параметры сортировки

required
StandardTariff (integer) or AdvancedTariff (integer) (TextLimit)

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "topOrderBy": "openToCart",
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "orderBy": {
    },
  • "limit": 20
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Заказы и позиции по поисковым запросам товара{{ /api/v2/search-report/product/orders }}

Описание метода

Метод формирует данные для таблицы по количеству заказов и позиций в поиске по запросам покупателя. Данные указаны в рамках периода для запрошенного товара.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (PeriodOrdersRequest)

Текущий период. Максимум 7 суток

nmId
required
integer <uint64>

Артикул WB

searchTexts
required
Array of strings [ 1 .. 30 ] items

Поисковые запросы. Для тарифа Продвинутый максимум — 100

Responses

Request samples

Content type
application/json
{
  • "period": {
    },
  • "nmId": 211131895,
  • "searchTexts": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

История остатков

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об аналитике истории остатков можно в справочном центре

Это информация из детализированной таблицы товаров и виджета детализации по регионам.

Остатки в данной версии методов — на текущий день.

Методы получения отчёта по истории остатков:

  1. Данных по таблице товаров с агрегацией по группам, товарам, размерам
  2. Данных виджета Статистика по регионам отгрузки с детализацией по складам

Данные по группам{{ /api/v2/stocks-report/products/groups }}

Описание метода

Метод формирует набор данных об остатках по группам товаров.

Группа товаров описывается кортежем subjectID, brandName, tagID.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

Список артикулов WB для фильтрации

subjectIDs
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIDs
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

required
object (PeriodSt)

Период

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Тип складов хранения товаров:

  • "" — все
  • wb — Склады WB
  • mp — Склады продавца
skipDeletedNm
required
boolean

Скрыть удалённые товары

availabilityFilters
required
Array of strings (availabilityFilters)
Items Enum: "deficient" "actual" "balanced" "nonActual" "nonLiquid" "invalidData"

Доступность товара:

  • deficient — Дефицит
  • actual — Актуальный
  • balanced — Баланс
  • nonActual — Неактуальный
  • nonLiquid — Неликвид
  • invalidData — Не рассчитано
required
object (TableOrderBy)

Вид сортировки данных

limit
integer <uint32> <= 1000
Default: 100

Количество групп в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": true,
  • "availabilityFilters": [
    ],
  • "orderBy": {
    },
  • "limit": 150,
  • "offset": 100
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Данные по товарам{{ /api/v2/stocks-report/products/products }}

Описание метода

Метод формирует набор данных об остатках по товарам.

Можно получить данные как по отдельным товарам, так и в рамках всего отчёта — если в запросе отсутствуют фильтры: nmIDs, subjectID, brandName, tagID.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

Список артикулов WB для фильтрации

subjectID
integer <int32>

ID предмета

brandName
string

Бренд

tagID
integer <int64>

ID ярлыка

required
object (PeriodSt)

Период

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Тип складов хранения товаров:

  • "" — все
  • wb — Склады WB
  • mp — Склады продавца
skipDeletedNm
required
boolean

Скрыть удалённые товары

required
object (TableOrderBy)

Вид сортировки данных

availabilityFilters
required
Array of strings (availabilityFilters)
Items Enum: "deficient" "actual" "balanced" "nonActual" "nonLiquid" "invalidData"

Доступность товара:

  • deficient — Дефицит
  • actual — Актуальный
  • balanced — Баланс
  • nonActual — Неактуальный
  • nonLiquid — Неликвид
  • invalidData — Не рассчитано
limit
integer <uint32> <= 1000
Default: 100

Количество товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectID": 123456,
  • "brandName": "Спортик",
  • "tagID": 25345,
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": true,
  • "orderBy": {
    },
  • "availabilityFilters": [
    ],
  • "limit": 150,
  • "offset": 100
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Данные по размерам{{ /api/v2/stocks-report/products/sizes }}

Описание метода

Метод формирует набор данных об остатках по размерам товара.

Возможны случаи:

  1. Товар имеет размеры и "includeOffice":true, тогда в ответе будут данные об остатках по каждому из размеров с вложенной детализацией по складам.
  2. Товар имеет размеры и "includeOffice":false, тогда в ответе будут данные об остатках по каждому из размеров без вложенной детализации по складам.
  3. Товар не имеет размера и "includeOffice":true, тогда в ответе будет детализация по складам. Без данных об остатках по каждому из размеров.
  4. Товар не имеет размера и "includeOffice":false, тогда тело ответа будет пустым.

    Товар не имеет размера, если у него единственный размер с "techSize":"0". В ответах метода получения данных по товарам у таких товаров "hasSizes":false.

    Данные по складам продавца приходят в агрегированном виде — по всем сразу, без детализации по конкретным складам — эти записи будут с "regionName":"Маркетплейс" и "officeName":"".
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmID
required
integer <int64>

Артикул WB

required
object (PeriodSt)

Период

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Тип складов хранения товаров:

  • "" — все
  • wb — Склады WB
  • mp — Склады продавца
required
object (TableOrderBy)

Вид сортировки данных

includeOffice
required
boolean

Включить детализацию по складам

Responses

Request samples

Content type
application/json
{
  • "nmID": 123456789,
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "orderBy": {
    },
  • "includeOffice": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Данные по складам{{ /api/v2/stocks-report/offices }}

Описание метода

Метод формирует набор данных об остатках по складам.

Данные по складам продавца приходят в агрегированном виде — по всем сразу, без детализации по конкретным складам — эти записи будут с "regionName":"Маркетплейс" и "offices":[].

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

Список артикулов WB для фильтрации

subjectIDs
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIDs
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

required
object (PeriodSt)

Период

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Тип складов хранения товаров:

  • "" — все
  • wb — Склады WB
  • mp — Склады продавца
skipDeletedNm
required
boolean

Скрыть удалённые товары

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Аналитика продавца CSV

Для доступа к методам используйте токен для категории Аналитика

Чтобы получить отчёт:

  1. Сгенерируйте его с помощью метода создания отчёта.
  2. Дождитесь, когда отчёт будет готов. Вы можете проверить статус готовности через получение списка отчётов. Готовый отчёт хранится 48 часов.
    Если вы получили статус FAILED, сгенерируйте отчёт повторно.
  3. Получите отчёт.

Можно получить отчёт максимум за год.

Максимальное количество отчётов, генерируемых в сутки — 20.

Вы можете использовать эти методы — за исключением отчёта по истории остатков — только с подпиской Джем.

Создать отчёт{{ /api/v2/nm-report/downloads }}

Описание метода

Метод создаёт задание на генерацию отчёта с расширенной аналитикой продавца.

Вы можете создать CSV-версии отчётов по воронке продаж или параметрам поиска с группировкой по:

  • артикулам WB
  • предметам, брендам и ярлыкам

В отчётах по воронке продаж можно группировать данные по дням, неделям или месяцам.

Также можете создать CSV-версии отчётов по текстам поисковых запросов и истории остатков.

Набор параметров запроса в объекте params зависит от типа отчёта. Чтобы получить описание параметров, выберите тип отчёта в раскрывающемся списке в описании параметра reportType.

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Если не удалось получить отчёт, можно создать повторное задание на генерацию. Также можно получить список и проверить статусы отчётов.

Отчёт по истории остатков — тип STOCK_HISTORY_REPORT_CSV — можно создать без подписки Джем
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
id
required
string <uuid>

ID отчёта в UUID-формате. Генерируется продавцом самостоятельно

reportType
required
string

Тип отчёта DETAIL_HISTORY_REPORT — Воронка продаж. По артикулам WB

userReportName
string

Название отчёта. Если не указано, сформируется автоматически

required
object

Параметры отчёта

Responses

Request samples

Content type
application/json
Example

Воронка продаж. По артикулам WB

{
  • "id": "06eae887-9d9f-491f-b16a-bb1766fcb8d2",
  • "reportType": "DETAIL_HISTORY_REPORT",
  • "userReportName": "Card report",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "data": "Created"
}

Получить список отчётов{{ /api/v2/nm-report/downloads }}

Описание метода

Метод возвращает список отчётов с расширенной аналитикой продавца. Ответ содержит ID созданных отчётов и статусы генерации.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
query Parameters
filter[downloadIds]
Array of strings <uuid> [ items <uuid > ]

ID отчёта

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Сгенерировать отчёт повторно{{ /api/v2/nm-report/downloads/retry }}

Описание метода

Метод создает повторное задание на генерацию отчёта с расширенной аналитикой продавца. Необходимо, если при генерации отчёта вы получили статус FAILED.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
downloadId
string <uuid>

ID отчёта

Responses

Request samples

Content type
application/json
{
  • "downloadId": "06eea887-9d9f-491f-b16a-bb1766fcb8d2"
}

Response samples

Content type
application/json
{
  • "data": "Retry"
}

Получить отчёт{{ /api/v2/nm-report/downloads/file/{downloadId} }}

Описание метода

Метод возвращает отчёт с расширенной аналитикой продавца по ID задания на генерацию.

Можно получить отчёт, который сгенерирован за последние 48 часов.
Отчёт будет загружен внутри архива ZIP в формате CSV.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 3 запроса 20 секунд 3 запроса
Authorizations:
HeaderApiKey
path Parameters
downloadId
required
string <uuid>

ID отчёта

Responses

Response samples

Content type
application/zip
Example
nmID, dt, openCardCount, addToCartCount, ordersCount, ordersSumRub, buyoutsCount, buyoutsSumRub, cancelCount, cancelSumRub, addToCartConversion, cartToOrderConversion, buyoutPercent, addToWishlist
70027655,2024-11-21,1,0,0,0,0,0,0,0,0,0,0,0
...
...
150317666,2024-11-21,2,0,0,0,0,0,0,0,0,0,0,0
Документация — WB API
Поиск

Основные отчёты

Для доступа к методам используйте токен для категории Статистика

Получение статистики по:

Основные отчёты можно сохранять в формате таблиц.

Сервис статистики не хранит историю остатков товаров, поэтому получить данные о них можно только на текущий момент

Поставки{{ /api/v1/supplier/incomes }}

Описание метода

Метод возвращает количество поставок товаров для хранения на складах WB.
Данные обновляются раз в 30 минут.

Для одного ответа в системе установлено условное ограничение 100000 строк. Поэтому, чтобы получить все поставки, может потребоваться более, чем один запрос. Во втором и далее запросе в параметре dateFrom используйте полное значение поля lastChangeDate из последней строки ответа на предыдущий запрос.
Если в ответе отдаётся пустой массив [], все поставки уже выгружены.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по поставке.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Москва (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Склады{{ /api/v1/supplier/stocks }}

Описание метода

Метод возвращает количество остатков товаров на складах WB.
Данные обновляются раз в 30 минут.

Для одного ответа в системе установлено условное ограничение 60000 строк. Поэтому, чтобы получить все остатки, может потребоваться более, чем один запрос. Во втором и далее запросе в параметре dateFrom используйте полное значение поля lastChangeDate из последней строки ответа на предыдущий запрос.
Если в ответе отдаётся пустой массив [], все остатки уже выгружены.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по товару.
Для получения полного остатка следует указывать максимально раннее значение.
Например, 2019-06-20
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Москва (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Заказы{{ /api/v1/supplier/orders }}

Описание метода

Метод возвращает информацию обо всех заказах.
Данные обновляются раз в 30 минут.

1 строка = 1 заказ = 1 cборочное задание = 1 единица товара.
Для определения заказа рекомендуем использовать поле srid.

Информация о заказе хранится 90 дней с момента оформления.

Для одного ответа на запрос с flag=0 или без flag в системе установлено условное ограничение 80000 строк. Поэтому, чтобы получить все заказы, может потребоваться более, чем один запрос. Во втором и далее запросе в параметре dateFrom используйте полное значение поля lastChangeDate из последней строки ответа на предыдущий запрос.
Если в ответе отдаётся пустой массив [], все заказы уже выгружены.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по заказу.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Москва (UTC+3).
Примеры:
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00
flag
integer
Default: 0

Если параметр flag=0 (или не указан в строке запроса), при вызове API возвращаются данные, у которых значение поля lastChangeDate (дата время обновления информации в сервисе) больше или равно переданному значению параметра dateFrom. При этом количество возвращенных строк данных варьируется в интервале от 0 до примерно 100 000.
Если параметр flag=1, то будет выгружена информация обо всех заказах или продажах с датой, равной переданному параметру dateFrom (в данном случае время в дате значения не имеет). При этом количество возвращенных строк данных будет равно количеству всех заказов или продаж, сделанных в указанную дату, переданную в параметре dateFrom.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Продажи{{ /api/v1/supplier/sales }}

Описание метода

Метод возвращает информацию о продажах и возвратах.
Данные обновляются раз в 30 минут.

1 строка = 1 заказ = 1 cборочное задание = 1 единица товара.
Для определения заказа рекомендуем использовать поле srid.

Информация о заказе хранится 90 дней с момента оформления.

Для одного ответа на запрос с flag=0 или без flag в системе установлено условное ограничение 80000 строк. Поэтому, чтобы получить все продажи и возвраты, может потребоваться более, чем один запрос. Во втором и далее запросе в параметре dateFrom используйте полное значение поля lastChangeDate из последней строки ответа на предыдущий запрос.
Если в ответе отдаётся пустой массив [], все продажи и возвраты уже выгружены.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по продаже/возврату.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Москва (UTC+3).
Примеры:
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00
flag
integer
Default: 0

Если параметр flag=0 (или не указан в строке запроса), при вызове API возвращаются данные, у которых значение поля lastChangeDate (дата время обновления информации в сервисе) больше или равно переданному значению параметра dateFrom. При этом количество возвращенных строк данных варьируется в интервале от 0 до примерно 100 000.
Если параметр flag=1, то будет выгружена информация обо всех заказах или продажах с датой, равной переданному параметру dateFrom (в данном случае время в дате значения не имеет). При этом количество возвращенных строк данных будет равно количеству всех заказов или продаж, сделанных в указанную дату, переданную в параметре dateFrom.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Отчёт об остатках на складах

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об отчётах по остаткам на складах можно в справочном центре

Чтобы получить отчёт об остатках на складах WB:

  1. Создайте отчёт.
  2. Дождитесь, когда отчёт будет готов. Вы можете проверить статус готовности отчёта. Готовый отчёт хранится 2 часа.
  3. Получите отчёт.

Создать отчёт{{ /api/v1/warehouse_remains }}

Описание метода

Метод создаёт задание на генерацию отчёта об остатках на складах WB.

Параметры groupBy и filter (группировки и фильтры) можно задать в любой комбинации — аналогично версии в личном кабинете.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 5 запросов
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "ru"
Example: locale=ru

Язык полей ответа subjectName и warehouseName:

  • ru — русский
  • en — английский
  • zh — китайский. Значения warehouseName на английском
groupByBrand
boolean
Default: false
Example: groupByBrand=true

Разбивка по брендам

groupBySubject
boolean
Default: false
Example: groupBySubject=true

Разбивка по предметам

groupBySa
boolean
Default: false
Example: groupBySa=true

Разбивка по артикулам продавца

groupByNm
boolean
Default: false
Example: groupByNm=true

Разбивка по артикулам WB. Если groupByNm=true, в ответе будет поле volume

groupByBarcode
boolean
Default: false
Example: groupByBarcode=true

Разбивка по баркодам

groupBySize
boolean
Default: false
Example: groupBySize=true

Разбивка по размерам

filterPics
integer
Default: 0
Example: filterPics=1

Фильтр по фото:

  • -1 — без фото
  • 0 — не применять фильтр
  • 1 — с фото
filterVolume
integer
Default: 0
Example: filterVolume=3

Фильтр по объёму:

  • -1 — без габаритов
  • 0 — не применять фильтр
  • 3 — свыше трёх литров

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Проверить статус{{ /api/v1/warehouse_remains/tasks/{task_id}/status }}

Описание метода

Метод возвращает статус задания на генерацию отчёта об остатках на складах WB.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
5 секунд 1 запрос 5 секунд 5 запросов
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить отчёт{{ /api/v1/warehouse_remains/tasks/{task_id}/download }}

Описание метода

Метод возвращает отчёт об остатках на складах WB по ID задания на генерацию.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Отчёт о товарах c обязательной маркировкой

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об отчётах по товарам с обязательной маркировкой можно в справочном центре

Чтобы получить отчёт с операциями по товарам с обязательной маркировкой, воспользуйтесь методом загрузки.

Получить отчёт{{ /api/v1/analytics/excise-report }}

Описание метода

Метод возвращает отчёт с операциями по товарам с обязательной маркировкой.

Данный отчёт можно сохранить в формате таблиц.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
5 часов 10 запросов 30 минут 10 запросов
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2025-02-28

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2025-03-21

Конец отчётного периода, ГГГГ-ММ-ДД

Request Body schema: application/json
optional
countries
Array of strings
Items Enum: "AM" "BY" "KG" "KZ" "RU" "UZ"

Код стран по стандарту ISO 3166-2. Чтобы получить данные по всем странам, оставьте параметр пустым

Responses

Request samples

Content type
application/json
{
  • "countries": [
    ]
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Отчёты об удержаниях

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об отчётах об удержаниях можно в справочном центре

Методы загрузки отчётов об удержаниях:

  1. Занижение габаритов упаковки
  2. Самовыкупы
  3. Подмена товара
  4. Маркировка товара
  5. Смена характеристик

Занижение габаритов упаковки{{ /api/v1/analytics/warehouse-measurements }}

Описание метода

Метод возвращает отчёты об удержаниях за занижение габаритов упаковки и замерах склада

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 5 запросов 12 секунд 1 запрос
Authorizations:
HeaderApiKey
query Parameters
dateFrom
string <date-time>
Example: dateFrom=2025-02-01T15:00:00Z

Начало отчётного периода. По умолчанию используется дата, когда были впервые получены данные для отчёта

dateTo
required
string <date-time>
Example: dateTo=2025-10-11T18:00:00Z

Конец отчётного периода

tab
required
string
Enum: "penalty" "measurement"
Example: tab=measurement

Тип отчёта:

  • penalty — Удержания за занижение габаритов упаковки
  • measurement — Замеры склада
limit
required
integer <= 1000
Example: limit=330

Количество удержаний или замеров в ответе

offset
integer
Default: 0
Example: offset=220

Сколько элементов пропустить. Например, для значения 10 ответ начнётся с 11 элемента

Responses

Response samples

Content type
application/json
Example

Удержания за занижение габаритов упаковки

{}

Самовыкупы{{ /api/v1/analytics/antifraud-details }}

Описание метода

Метод возвращает отчёт об удержаниях за самовыкупы. Отчёт формируется каждую неделю по средам, до 7:00 по московскому времени, и содержит данные за одну неделю.

Удержание за самовыкуп — 30% от стоимости товаров.
Минимальная сумма всех удержаний — 100 000 ₽, если за неделю в ПВЗ привезли ваших товаров больше, чем на сумму 100 000 ₽.

Данные доступны с августа 2023.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
100 минут 10 запросов 10 минут 10 запросов
Authorizations:
HeaderApiKey
query Parameters
date
string
Example: date=2023-12-01

Дата, которая входит в отчётный период, ГГГГ-ММ-ДД.
Чтобы получить данные за всё время с августа 2023, не указывайте этот параметр

Responses

Response samples

Content type
application/json
{
  • "details": [
    ]
}

Подмена товара{{ /api/v1/analytics/incorrect-attachments }}

Описание метода

Метод возвращает отчёт об удержаниях за отправку ошибочных товаров, пустых коробок или коробок без товара, но с посторонними предметами. В таких случаях удерживается 100% от стоимости заказа.

Можно получить отчёт максимум за 31 день. Данные доступны с июня 2023.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 10 запросов
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2025-02-28

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2025-03-21

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{}

Маркировка товара{{ /api/v1/analytics/goods-labeling }}

Описание метода

Метод возвращает отчёт о штрафах за отсутствие обязательной маркировки товаров.

В отчёте представлены фотографии товаров, на которых маркировка отсутствует либо не считывается.

Можно получить данные максимум за 31 день. Данные доступны с марта 2024.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 минут 10 запросов 1 минута 10 запросов
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <date>
Example: dateFrom=2024-04-01

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string <date>
Example: dateTo=2024-04-30

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json

Смена характеристик{{ /api/v1/analytics/characteristics-change }}

Описание метода

Метод возвращает отчёт об удержаниях за смену характеристик товара. Если товары после приёмки не соответствуют заявленным цветам и размерам, и на складе их перемаркировали с правильными характеристиками, по таким товарам назначается штраф.

Можно получить отчёт максимум за 31 день. Данные доступны с 28 декабря 2021.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 минут 10 запросов 1 минута 10 запросов
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <date>
Example: dateFrom=2024-04-01

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string <date>
Example: dateTo=2024-04-30

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Платная приёмка

Для доступа к методам используйте токен для категории Аналитика

Чтобы получить отчёт о платной приёмке:

  1. Создайте отчёт.
  2. Дождитесь, когда отчёт будет готов. Вы можете проверить статус готовности отчёта. Готовый отчёт хранится 2 часа.
  3. Получите отчёт.

Создать отчёт{{ /api/v1/acceptance_report }}

Описание метода

Метод создаёт задание на генерацию отчёта о платной приёмке.

Можно получить отчёт максимум за 31 день.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2025-02-28

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2025-03-21

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Проверить статус{{ /api/v1/acceptance_report/tasks/{task_id}/status }}

Описание метода

Метод возвращает статус задания на генерацию отчёта о платной приёмке.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
5 секунд 1 запрос 5 секунд 1 запрос
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить отчёт{{ /api/v1/acceptance_report/tasks/{task_id}/download }}

Описание метода

Метод возвращает отчёт о платной приёмке по ID задания на генерацию.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Платное хранение

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об отчётах о платном хранении можно в справочном центре

Чтобы получить отчёт о платном хранении:

  1. Создайте отчёт.
  2. Дождитесь, когда отчёт будет готов. Вы можете проверить статус готовности отчёта. Готовый отчёт хранится 2 часа, после чего его нельзя будет получить.
  3. Получите отчёт.

Создать отчёт{{ /api/v1/paid_storage }}

Описание метода

Метод создаёт задание на генерацию отчёта о платном хранении.

Можно получить отчёт максимум за 8 дней.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 5 запросов
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2022-01-01

Начало отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00
dateTo
required
string
Example: dateTo=2022-01-09

Конец отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Проверить статус{{ /api/v1/paid_storage/tasks/{task_id}/status }}

Описание метода

Метод возвращает статус задания на генерацию отчёта о платном хранении.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
5 секунд 1 запрос 5 секунд 5 запросов
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить отчёт{{ /api/v1/paid_storage/tasks/{task_id}/download }}

Описание метода

Метод возвращает отчёт о платном хранении по ID задания на генерацию.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Продажи по регионам

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об отчётах о продажах по регионам можно в справочном центре

Чтобы получить отчёт о продажах по регионам, воспользуйтесь методом загрузки.

Получить отчёт{{ /api/v1/analytics/region-sale }}

Описание метода

Метод возвращает отчёт с данными продаж, сгруппированных по регионам стран.

Можно получить отчёт максимум за 31 день.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 1 запрос 10 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2025-02-28

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2025-03-21

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Доля бренда в продажах

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об отчётах о доле бренда в продажах можно в справочном центре

Отчёты о доле бренда продавца в продажах.

Для получения отчёта вам понадобятся:

  1. Названия брендов.
  2. ID категорий.

Можно получить отчёт максимум за 365 дней.

Бренды продавца{{ /api/v1/analytics/brand-share/brands }}

Описание метода

Метод возвращает список брендов продавца для отчёта о доле бренда в продажах.

Можно получить только бренды, которые:

  • Продавались за последние 90 дней.
  • Есть на складе WB.
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 10 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Родительские категории бренда{{ /api/v1/analytics/brand-share/parent-subjects }}

Описание метода

Метод возвращает родительские категории бренда продавца для отчёта о доле бренда в продажах.

Можно получить отчёт максимум за 365 дней. Данные доступны с 1 ноября 2022.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
5 секунд 1 запрос 5 секунд 20 запросов
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "ru"
Example: locale=ru

Язык поля ответа parentName:

  • ru — русский
  • en — английский
  • zh — китайский
brand
required
string
Example: brand=H%26M

Бренд

dateFrom
required
string
Example: dateFrom=2025-02-28

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2025-03-21

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Получить отчёт{{ /api/v1/analytics/brand-share }}

Описание метода

Метод возвращает отчёт о доле бренда продавца в продажах.

Можно получить отчёт максимум за 365 дней. Данные доступны с 1 ноября 2022.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
5 секунд 1 запрос 5 секунд 20 запросов
Authorizations:
HeaderApiKey
query Parameters
parentId
required
integer
Example: parentId=1

ID родительской категории

brand
required
string
Example: brand=H%26M

Бренд

dateFrom
required
string
Example: dateFrom=2025-02-28

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2025-03-21

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Скрытые товары

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об отчётах о скрытых товарах можно в справочном центре

Методы загрузки отчётов о скрытых товарах:

  1. Заблокированные карточки
  2. Скрытые из каталога

Заблокированные карточки{{ /api/v1/analytics/banned-products/blocked }}

Описание метода

Метод возвращает список заблокированных карточек товаров продавца с причинами блокировки.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 1 запрос 10 секунд 6 запросов
Authorizations:
HeaderApiKey
query Parameters
sort
required
string
Enum: "brand" "nmId" "title" "vendorCode" "reason"
Example: sort=nmId

Сортировка

  • brand — по бренду
  • nmId — по артикулу WB
  • title — по наименованию товара
  • vendorCode — по артикулу продавца
  • reason — по причине блокировки
order
required
string
Enum: "desc" "asc"
Example: order=asc

Порядок выдачи

  • desc — от наибольшего числового значения к наименьшему, от последнего по алфавиту значения к первому
  • asc — от наименьшего числового значения к наибольшему, от первого по алфавиту значения к последнему

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Скрытые из каталога{{ /api/v1/analytics/banned-products/shadowed }}

Описание метода

Метод возвращает список товаров продавца, скрытых из каталога.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 1 запрос 10 секунд 6 запросов
Authorizations:
HeaderApiKey
query Parameters
sort
required
string
Enum: "brand" "nmId" "title" "vendorCode" "nmRating"
Example: sort=title

Сортировка

  • brand — по бренду
  • nmId — по артикулу WB
  • title — по наименованию товара
  • vendorCode — по артикулу продавца
  • nmRating — по рейтингу товара
order
required
string
Enum: "desc" "asc"
Example: order=desc

Порядок выдачи

  • desc — от наибольшего числового значения к наименьшему, от последнего по алфавиту значения к первому
  • asc — от наименьшего числового значения к наибольшему, от первого по алфавиту значения к последнему

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Отчёт о возвратах и перемещении товаров

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об отчётах о возвратах и перемещении товаров можно в справочном центре

Чтобы получить отчёт о возвратах товаров, воспользуйтесь методом загрузки.

Получить отчёт{{ /api/v1/analytics/goods-return }}

Описание метода

Метод возвращает отчёт о возвратах товаров продавцу.

Можно получить отчёт максимум за 31 день.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 10 запросов
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <date>
Example: dateFrom=2024-08-13

Дата начала отчётного периода

dateTo
required
string <date>
Example: dateTo=2024-08-27

Дата окончания отчётного периода

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}
Документация — WB API
Поиск

Документы и бухгалтерия (finances)

Узнать больше о документах и бухгалтерии можно в справочном центре

Просмотр баланса, финансовых отчётов и документов продавца.

Документы и бухгалтерия

Узнать больше о документах и бухгалтерии можно в справочном центре

Просмотр баланса, финансовых отчётов и документов продавца.

Баланс

Для доступа к методам используйте токен для категории Финансы
Узнать больше о балансе продавца можно в справочном центре

Чтобы получить текущий баланс, воспользуйтесь методом загрузки.

Получить баланс продавца{{ /api/v1/account/balance }}

Описание метода

Метод возвращает данные виджета баланса на главной странице портала продавцов.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "currency": "RUB",
  • "current": 10196.21,
  • "for_withdraw": 6395.8
}

Финансовые отчёты

Для доступа к методам используйте токен для категории Статистика
Узнать больше о финансовых отчётах можно в справочном центре

Чтобы получить отчёт о продажах по реализации, воспользуйтесь методом загрузки.

Отчёт о продажах по реализации{{ /api/v5/supplier/reportDetailByPeriod }}

Описание метода

Метод возвращает детализации к отчётам реализации.

Данные доступны с 29 января 2024 года.

Вы можете выгрузить данные в Google Таблицы
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Начальная дата отчёта.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Москва (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00
dateTo
required
string <date>

Конечная дата отчёта

limit
integer <= 100000
Default: 100000

Количество строк в ответе

rrdid
integer
Default: 0

Уникальный ID строки отчёта. Необходим для получения отчёта частями.
Загрузку отчёта нужно начинать с rrdid = 0 и при последующих вызовах API передавать в запросе значение rrd_id из последней строки, полученной в результате предыдущего вызова.
Таким образом, для загрузки одного отчёта может понадобиться вызывать API до тех пор, пока в ответе не будет отдан пустой массив [].

period
string
Default: "weekly"
Enum: "weekly" "daily"

Периодичность отчёта:

  • weekly — еженедельный
  • daily — ежедневный

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Документы

Для доступа к методам используйте токен для категории Документы

С помощью этих методов вы можете получить документы продавца различных категорий: акты, бухгалтерские отчёты, оферты, письма, списки товаров, УКД, УПД, уведомления и так далее.

Для работы с документами получите списки:

  1. Категорий документов
  2. Документов продавца, доступных для загрузки

Вы можете загрузить один или несколько документов из полученного списка.

Категории документов{{ /api/v1/documents/categories }}

Описание метода

Метод возвращает категории документов для получения списка документов продавца.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 1 запрос 10 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "en"
Example: locale=ru

Язык поля title:

  • ru — русский
  • en — английский
  • zh — китайский

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Список документов{{ /api/v1/documents/list }}

Описание метода

Метод возвращает список документов продавца. Вы можете получить один или несколько документов из полученного списка.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 1 запрос 10 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "en"
Example: locale=ru

Язык поля category:

  • ru — русский
  • en — английский
  • zh — китайский
beginTime
string <date>
Example: beginTime=2024-07-09

Начало периода. Только вместе с endTime

endTime
string <date>
Example: endTime=2024-07-15

Конец периода. Только вместе с beginTime

sort
string
Default: "date"
Enum: "date" "category"
Example: sort=category

Сортировка:

  • date — по дате создания документа
  • category — по категории (только при locale=ru)

Только вместе с order

order
string
Default: "desc"
Enum: "desc" "asc"
Example: order=asc

Сортировка:

  • desc — по убыванию
  • asc — по возрастанию

Только вместе с sort

category
string
Example: category=redeem-notification
serviceName
string
Example: serviceName=redeem-notification-44841941

Уникальный ID документа

limit
integer <= 50
Default: 50
Example: limit=10

Максимальное количество строк ответа

offset
integer
Default: 0
Example: offset=90

После какой строки выдавать данные

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить документ{{ /api/v1/documents/download }}

Описание метода

Метод загружает один документ из списка документов продавца.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 1 запрос 10 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
serviceName
required
string
Example: serviceName=redeem-notification-44841941

Уникальный ID документа

extension
required
string
Example: extension=zip

Формат документа

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить документы{{ /api/v1/documents/download/all }}

Описание метода

Метод загружает несколько документов из списка документов продавца.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
5 минут 1 запрос 5 минут 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
Array of objects [ 1 .. 50 ] items

Responses

Request samples

Content type
application/json
{
  • "params": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}
Документация — WB API
Поиск

Wildberries Цифровой (wbd)

По вопросам работы с WBD API обращайтесь в техническую поддержку

Wildberries Цифровой

По вопросам работы с WBD API обращайтесь в техническую поддержку

Введение WBD

Добро пожаловать в Wildberries Digital (WBD) API — интерфейс для продавцов Wildberries Цифровой, предоставляющий возможности управления магазином и получения оперативной и статистической информации по протоколу HTTP.

Основные возможности WBD API

  • Управление предложениями и контентом
  • Загрузка и управление медиафайлами
  • Получение информации о контенте и предложениях
  • Управление ключами активации

Формат и инструменты для работы с API

API представлен в формате Swagger (OpenAPI), что позволяет легко импортировать его в такие инструменты как Postman и генерировать клиентский код на различных языках программирования с помощью Swagger CodeGen. Для ручной проверки API вы можете использовать:

Авторизация WBD

Срок действия токена — 365 дней

Для доступа к WBD API необходимо пройти авторизацию с использованием JWT. Следуйте инструкциям ниже для получения и использования токена.

Получение токена

  1. Перейдите по ссылке на сайт WBD.
  2. Нажмите кнопку Получить токен.
  3. Скопируйте сгенерированный токен JWT.

Использование токена
В каждом запросе к WBD API передавайте токен в заголовке Authorization, где <api_token> — ваш токен авторизации (JWT):

Authorization: Bearer <api_token>

Пример запроса:

GET /api/v1/offers/author HTTP/1.1
Host: devapi-digital.wildberries.ru
Authorization: Bearer eyJhbGciOdJIUzI1NiIsInR5cCIkIkpXVCJ9.eyJhJjo0ODM2MTE5NawiYiI6NDI4NTk1MjMsImV4cCI6MTc0OTU0MjQ0MH0.DOWjZBSLwCxvU_kKkneCcJ_E-GuflHSsre8nAUr0xFo

Рекомендации по безопасности

  • Храните токен в безопасном месте
  • Не передавайте токен в URL
  • Не выкладывайте токен в публичный доступ

Для всех запросов используйте хост devapi-digital.wildberries.ru.

Пример полного URL: https://devapi-digital.wildberries.ru/api/v1/offers/author.

Соблюдение этих рекомендаций обеспечит безопасное использование WBD API.

Предложения

Создать новое предложение{{ /api/v1/offers }}

Описание метода

Метод позволяет создать новое предложение.

Обязательные поля

  • title — Название предложения
  • description — Описание предложения
  • tags — Теги предложения
  • section — Категория предложения
  • catalog_path — Подкатегория предложения
  • age_rating — Возрастное ограничение предложения
  • price — Цена предложения

Добавить обложку

Обложка для предложения загружается отдельно после создания предложения.
Вам необходимо воспользоваться методом Добавить или обновить обложку предложения.

Добавить дополнительные медиафайлы

  1. Загрузить медиафайлы с помощью метода Загрузить медиафайл для предложения, метод возвращает список URI адресов загруженных медиафайлов.
  2. Добавить URI медиафайлов в поле gallery.

Категория и подкатегория предложения

Воспользуйтесь методом Получить категории и их подкатегории для получения ID подкатегории и правильного сопоставления с категорией.

Предложение из категории "Услуги"

section8

Доступ к публикации контента этой категории предоставляется через заявку в техническую поддержку.

Предложение c уникальными ключами

Предложение c уникальными ключами относятся к категориям (section):

  • Ключи активации3
  • Купоны и развлечения12
  • Подарочные сертификаты13

Обязательные данные:

  • Ключи к предложению
  • Инструкция по активации ключа

Загрузка ключей

Список ключей передается в параметре keys вашего запроса при создании предложения.
В дальнейшем вы можете добавлять ключи с помощью метода Добавить ключи активации.

Добавление инструкции по активации ключа

Инструкцию по активации ключа необходимо добавить в поле meta в формате JSON используя следующий пример.
Чтобы сделать текст более привлекательным и удобочитаемым, используйте перенос строки \n.

Пример:

{
    "meta":{
        "key_instruction": "Инструкция по активации\n1. Зайдите на сайт ...\n2.Вставьте ключ в поле ..."
    }
}

Предложение с контентом

Предложение с контентом относится к категориям (section):

  • Видеоконтент1
  • Аудиоконтент2
  • Электронные книги4
  • Аудиокниги5
  • Цифровые товары6

Обязательные данные:

  • Контент для предложения

Добавление контента

Если вы ещё не добавили контент в личный кабинет продавца, то вы можете это сделать по инструкции.

Для добавления контента вам необходимо передать в параметре content список данных используя пример ниже.

Пример:

"content": [
    {
        "category_id": 1,
        "content": 8942
    },
    {
        "category_id": 1,
        "content": 4211
    }
]

где:

  • category_id — ID категории контента
  • content — ID контента

Эту информацию вы можете получить с помощью метод Получить список своего контента.

Максимум 50 запросов в секунду
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
title
required
string <= 500 characters

Название предложения.
Максимальная длина — 500 символов.

description
required
string <= 5000 characters

Описание предложения. Это текст, который описывает ваше предложение и помогает людям понять, что именно представляет из себя продаваемый вами товар и чем он может быть полезен. Важно правильно назвать предложение и более подробно прописать его описание, чтобы пользователи узнали как можно больше информации еще до покупки.
Максимальная длина — 5000 символов.

tags
required
Array of strings [ 1 .. 5 ] items [ items <= 45 characters ]

Массив тегов. Теги нужны для группирования, ранжирования и облегчения поиска вашего товара.

Ограничения:

  • Максимальное количество тегов — 5
  • Максимальная длина тега — 45 символов
section
required
integer <int32>
Enum: 1 2 3 4 5 6 8 9 12 13

ID категории предложения:

  • 1 — Видеоконтент
  • 2 — Аудиоконтент
  • 3 — Ключи активации
  • 4 — Электронные книги
  • 5 — Аудиокниги
  • 6 — Цифровые товары
  • 8 — Услуги
  • 12 — Купоны и развлечения
  • 13 — Подарочные сертификаты
catalog_path
required
Array of integers <int64> non-empty [ items <int64 > ]

Массив ID подкатегорий, в котором находится предложение.
Воспользуйтесь методом Получить категории и их подкатегории для получения ID и правильного сопоставления с категорией.

age_rating
required
string
Enum: "0+" "6+" "12+" "14+" "16+" "18+"

Возрастное ограничение. Это система, которая используется для определения, подходит ли ваше предложение для определенной возрастной группы.

price
required
integer <int64>

Цена предложения, ₽

discount_price
integer <int64>

Цена с учетом скидки, ₽

gallery
Array of strings <= 8 items

Список URL-адресов дополнительных изображений, а так же видео превью.
Можно передать до 8 медиафайлов.
Важно, чтобы все изображения были в формате JPG или PNG, а видео в формате MP4

keys
Array of strings <= 1000 items [ items <= 200 characters ]

Список ключей.
Это обязательное поле, если вы хотите создать предложение из категории (section):

  • Ключи активации3
  • Купоны и развлечения12
  • Подарочные сертификаты13

Ограничения:

  • Максимальное количество ключей — 1000
  • Максимальная длина ключа — 200 символов
status
integer <int32>
Default: 0
Enum: 0 1

Задается статус вашего предложения:

  • 0 — Добавить в черновик
  • 1 — Опубликовать
Array of objects (OfferCreateContent)

Список контента

object (OfferMetaRequest)

Метаданные предложения

Responses

Request samples

Content type
application/json
{
  • "title": "Книга `Спортивное питание`",
  • "description": "Очень хорошая книга о спортивном питании.",
  • "tags": [
    ],
  • "section": 4,
  • "catalog_path": [
    ],
  • "age_rating": "16+",
  • "price": 849,
  • "discount_price": 799,
  • "gallery": [
    ],
  • "keys": [
    ],
  • "status": 1,
  • "content": [
    ],
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "id": 42,
  • "title": "Книга `Спортивное питание`",
  • "description": "Очень хорошая книга о спортивном питании.",
  • "section": 4,
  • "catalog_path": [
    ],
  • "price": 849,
  • "discount_price": 799,
  • "gallery": [
    ],
  • "meta": "string",
  • "tags": [
    ],
  • "thumbnail": [
    ],
  • "content": [
    ],
  • "created": "2024-06-10T07:29:30Z",
  • "updated": "2024-06-17T22:12:13Z",
  • "deleted": "2024-06-19T22:12:13Z",
  • "status": 1,
  • "view_count": 47,
  • "purchase_count": 10,
  • "adult": false,
  • "age_rating": "16+",
  • "rating": 50
}

Добавить или обновить обложку предложения{{ /api/v1/offers/thumb }}

Описание метода

Метод позволяет добавить или обновить обложку предложения.
Для добавления более привлекательной карточки предложения, мы рекомендуем:

  1. Добавлять изображения с соотношением сторон 1:1.
  2. Минимальный размер изображения 1200х1200 пикселей.
  3. Фон контрастный белому.
Максимальный размер файла: 5 Мб
Допустимые форматы: PNG, JPEG
Максимум 10 запросов в секунду
Authorizations:
ApiKeyAuth
header Parameters
X-Content-Type
required
string
Enum: "image/jpeg" "image/png"

Тип изображения

X-Wbd-OfferId
required
integer <int64>

ID предложения

Request Body schema: application/octet-stream
required
string <binary>

Байты файла

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "title": "bad request",
  • "detail": "value 'five' is invalid for parameter offer_id",
  • "code": "string",
  • "errors": [
    ],
  • "requestId": "b709d59bd0791513350332ffe5f813c1",
  • "origin": "gateway-dev"
}

Редактировать предложение{{ /api/v1/offers/{offer_id} }}

Описание метода

Метод позволяет редактировать информацию о предложении.

Категория и подкатегория предложения

Воспользуйтесь методом Получить категории и их подкатегории для получения ID подкатегории и правильного сопоставления с категорией.

Максимум 50 запросов в секунду
Authorizations:
ApiKeyAuth
path Parameters
offer_id
required
integer <int64>

ID предложения

Request Body schema: application/json
required
title
string <= 500 characters

Название предложения.
Максимальная длина — 500 символов.

description
string <= 5000 characters

Описание предложения. Это текст, который описывает ваше предложение и помогает людям понять, что именно представляет из себя продаваемый вами товар и чем он может быть полезен. Важно правильно назвать предложение и более подробно прописать его описание, чтобы пользователи узнали как можно больше информации еще до покупки.
Максимальная длина — 5000 символов.

price
integer <int64>

Цена предложения, ₽

discount_price
integer or null <int64>

Цена с учетом скидки, ₽

gallery
Array of strings or null <= 8 items

Список URL-адресов дополнительных изображений, а так же видео превью.
Можно передать до 8 медиафайлов.
Важно, чтобы все изображения были в формате JPG или PNG, а видео в формате MP4

age_rating
string
Enum: "0+" "6+" "12+" "14+" "16+" "18+"

Возрастное ограничение. Это система, которая используется для определения, подходит ли ваше предложение для определенной возрастной группы.

tags
Array of strings [ 1 .. 5 ] items [ items <= 45 characters ]

Массив тегов. Теги нужны для группирования, ранжирования и облегчения поиска вашего товара.

Ограничения:

  • Максимальное количество тегов — 5
  • Максимальная длина тега — 45 символов
status
integer or null <int32>
Enum: 0 1 2 3

Статус вашего предложения:

  • 0 — Добавить в черновик
  • 1 — Опубликовать
  • 2 — Приостановить продажу
  • 3 — Удалить
catalog_path
Array of integers <int64> [ items <int64 > ]

Массив ID подкатегорий, в котором находится предложение.
Воспользуйтесь методом Получить категории и их подкатегории для получения ID и правильного сопоставления с категорией.

object (OfferMetaRequest)

Метаданные предложения

Responses

Request samples

Content type
application/json
{
  • "title": "Книга `Спортивное питание`",
  • "description": "Очень хорошая книга о спортивном питании.",
  • "price": 849,
  • "discount_price": 799,
  • "gallery": [
    ],
  • "age_rating": "16+",
  • "tags": [
    ],
  • "status": 1,
  • "catalog_path": [
    ],
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": 400,
  • "title": "bad request",
  • "detail": "value 'five' is invalid for parameter offer_id",
  • "code": "string",
  • "errors": [
    ],
  • "requestId": "b709d59bd0791513350332ffe5f813c1",
  • "origin": "gateway-dev"
}

Получить информацию о предложении{{ /api/v1/offers/{offer_id} }}

Описание метода

Метод позволяет получить информацию о конкретном предложении.

Максимум 100 запросов в секунду
Authorizations:
ApiKeyAuth
path Parameters
offer_id
required
integer <int64>

ID предложения

Responses

Response samples

Content type
application/json
{
  • "id": 42,
  • "title": "Книга `Спортивное питание`",
  • "description": "Очень хорошая книга о спортивном питании.",
  • "section": 4,
  • "catalog_path": [
    ],
  • "price": 849,
  • "discount_price": 799,
  • "gallery": [
    ],
  • "meta": "string",
  • "tags": [
    ],
  • "thumbnail": [
    ],
  • "content": [
    ],
  • "created": "2024-06-10T07:29:30Z",
  • "updated": "2024-06-17T22:12:13Z",
  • "deleted": "2024-06-19T22:12:13Z",
  • "status": 1,
  • "view_count": 47,
  • "purchase_count": 10,
  • "adult": false,
  • "age_rating": "16+",
  • "rating": 50
}

Получить список своих предложений{{ /api/v1/offers/author }}

Описание метода

Метод позволяет получить список своих предложений с использованием фильтрации.

Описание параметров фильтрации

  • search — Поиск предложений по названию. Укажите часть или полное название предложения для поиска.
  • category — Фильтрация предложений по категории контента. Список категорий находится в таблице.
  • status — Фильтрация предложений по статусу. Возможные значения:
    • 0 — Черновик
    • 1 — Опубликован
    • 2 — Приостановлен
  • sort — Сортировка предложений по дате создания или обновления. Укажите created для сортировки по дате создания и updated для сортировки по дате обновления.
  • sort_dir — Направление сортировки. Укажите asc для сортировки по возрастанию или desc для сортировки по убыванию.
  • skip — Смещение. Позволяет пропустить определенное количество предложений в результирующем наборе.
    Например, если skip равно 20, то выборка начнется с 21 записи.
  • take — Количество предложений, которое нужно вернуть в ответе.
    Например, если take равно 10, то в ответе будет не более 10 записей.
Максимум 100 запросов в секунду
Authorizations:
ApiKeyAuth
query Parameters
search
string

Поиск по названию предложения

category
integer <int64>
Enum: 1 2 4

Фильтрация по категории контента:

  • 1 — Видеоконтент
  • 2 — Аудиоконтент
  • 4 — Документ
status
integer <int32>
Enum: 0 1 2

Фильтрация по статусу:

  • 0 — Черновик
  • 1 — Опубликован
  • 2 — Приостановлен
sort
string
Enum: "created" "updated"

Сортировка предложений по дате создания или обновления

sort_dir
string
Enum: "asc" "desc"

Направление сортировки:

  • asc — по возрастанию
  • desc — по убыванию
skip
integer <int64>
Default: 0

Смещение. Количество предложений, которые нужно пропустить в результирующем наборе

take
integer <int64>
Default: 50

Количество предложений для получения

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 10
}

Обновить цену{{ /api/v1/offer/price/{offer_id} }}

Описание метода

Метод позволяет изменить цену предложения и цену с учетом скидок.

Если вы не хотите выставлять скидку, то в запросе необходимо не передавать параметр discount_price или выставить у него значение 0.

Максимум 50 запросов в секунду
Authorizations:
ApiKeyAuth
path Parameters
offer_id
required
integer <int64>

ID предложения

Request Body schema: application/json
required
regular_price
integer <int64>

Цена, ₽

discount_price
integer <int64>

Цена с учетом скидки, ₽

Responses

Request samples

Content type
application/json
{
  • "regular_price": 5432,
  • "discount_price": 5000
}

Response samples

Content type
application/json
{
  • "status": 400,
  • "title": "bad request",
  • "detail": "value 'five' is invalid for parameter offer_id",
  • "code": "string",
  • "errors": [
    ],
  • "requestId": "b709d59bd0791513350332ffe5f813c1",
  • "origin": "gateway-dev"
}

Обновить статус{{ /api/v1/offer/{offer_id} }}

Описание метода

Метод позволяет обновить статус вашего предложения.

Возможные значения:

  • 0 — Черновик
  • 1 — Опубликован
  • 2 — Приостановлен
  • 3 — Удалён
Максимум 50 запросов в секунду
Authorizations:
ApiKeyAuth
path Parameters
offer_id
required
integer <int64>

ID предложения

Request Body schema: application/json
required
status
required
integer <int32>
Enum: 0 1 2 3

Responses

Request samples

Content type
application/json
{
  • "status": 0
}

Response samples

Content type
application/json
{
  • "status": 400,
  • "title": "bad request",
  • "detail": "value 'five' is invalid for parameter offer_id",
  • "code": "string",
  • "errors": [
    ],
  • "requestId": "b709d59bd0791513350332ffe5f813c1",
  • "origin": "gateway-dev"
}

Получить категории и их подкатегории{{ /api/v1/catalog }}

Описание метода

Метод позволяет получить дерево (структуру данных) с категориям и их подкатегориями.

Иерархия структуры данных

В нашей структуре есть три уровня иерархии:

  1. Корневой узел — сущность Каталог
  2. Внешние узлы представляют собой категории (section):
  • 1 — Видеоконтент
  • 2 — Аудиоконтент
  • 3 — Ключи активации
  • 4 — Электронные книги
  • 5 — Аудиокниги
  • 6 — Цифровые товары
  • 8 — Услуги
  • 12 — Купоны и развлечения
  • 13 — Подарочные сертификаты
  1. Листья дерева являются подкатегориями (catalog_path):
  • 65 — Обучающие видео
  • 66 — Спорт
  • 67 — Мастер-класс
  • 68 — Йога
  • 69 — Медитации
Максимум 100 запросов в секунду
Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Контент

Категории контента

catalog_id — Идентифицировать категории Название категории Форматы файлов
1 Видеоконтент mp4
2 Аудиоконтент mp3
4 Документ pdf, epub, txt

Требования к контенту

Допустимый контент для загрузки

  • Видео (MP4)
  • Аудио/Музыка (MP3)
  • Документы (PDF, EPUB, TXT)

Требования к файлам

  • Максимальный размер файла: 3 Гб
  • Минимальная продолжительность видео/аудио: 1 минута
  • Поддерживаемые форматы: MP4, EPUB, TXT, PDF, MP3

Требования к обложке

  • Максимальный размер: 5 Мб
  • Поддерживаемые форматы: PNG, JPG (JPEG)
  • Формат изображения: 1:1 (рекомендуется)

Загрузить обложку контента{{ /api/v1/content/illustration }}

Описание метода

Метод позволяет загрузить обложку контента.

Максимальный размер файла: 5 Мб
Допустимые форматы: PNG, JPEG
Рекомендации:
  • Соотношение сторон 1:1

Краткая инструкция по применению:

  1. Убедитесь, что ваш файл соответствует указанным ограничениям и рекомендациям.
  2. Вызовите этот метод.
  3. При загрузке обложки вы получите список URI адресов для нового контента.
  4. Воспользуйтесь методом Инициализировать новый контент и передайте список URI адресов в поле meta в формате JSON используя следующий пример.

Пример:

{
    "meta": {
        "thumbnail": [
            "vol6/529/013cfs7f229183179aj53d2b3bbb839a/480.jpg",
            "vol6/529/013cfs7f229183179aj53d2b3bbb839a/1280.jpg",
            "vol6/529/013cfs7f229183179aj53d2b3bbb839a/1920.jpg"
        ]
    }
}
Максимум 10 запросов в секунду
Authorizations:
ApiKeyAuth
header Parameters
X-Content-Type
required
string
Enum: "image/png" "image/jpeg"

Тип файла

Request Body schema: application/octet-stream
required
string <binary>

Байты файла

Responses

Response samples

Content type
application/json
{
  • "uris": [
    ],
  • "userId": 483611
}

Инициализировать новый контент{{ /api/v1/content/upload/init }}

Описание метода

Метод позволяет инициализировать (загрузить) информацию нового контента.

Типы контента и требования к ним вы можете посмотреть в оглавлении Работа с контентом.

Подготовка файла к последующей загрузке:

  • Вам необходимо разбить файл на части (фреймы) не более 2 Мб.
  • Передать размер (в байтах) каждой части и порядковый номер в параметре parts.

Пример:
Файл размером 5 Мб, нужно разбить на 3 части — 2 Мб, 2 Мб и 1 Мб.

{
    "parts": [
        {
          "index": 1,
          "size": 2097152
        },
        {
          "index": 2,
          "size": 2097152
        },
        {
          "index": 3,
          "size": 1048576
        }
    ],
}

В методе Загрузить контент (файл) вам нужно будет загрузить 3 части файла с указанием их порядкового номера через X-Wbd-Part-Index.

Обязательные поля в метаданных (meta) для загрузки контента

Общие поля:

  • thumbnail
  • rating

Аудиоконтент:

  • author

Документ:

  • author
  • pages

Краткая инструкция по применению:

  1. Подготовьте метаданные и информацию о вашем контенте.
  2. Убедитесь, что ваш контент соответствует требованиям (формат и размер файла).
  3. Вызовите этот метод для инициализации нового контента.
  4. В ответе вы получите uuid контента, необходимый для последующей загрузки самого файла.
  5. Используйте метод Загрузить файл контента, чтобы загрузить файл.
Максимум 10 запросов в секунду
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
title
required
string <= 500 characters

Название контента.
Максимальная длина — 500 символов.

description
required
string <= 1000 characters

Описание контента.
Максимальная длина — 1000 символов.

catalog_id
required
integer
Enum: 1 2 4

ID категории контента:

  • 1 — Видеоконтент
  • 2 — Аудиоконтент
  • 4 — Документ
content_type
required
string
Enum: "video/mp4" "audio/mpeg" "text/plain" "application/pdf" "application/epub+zip"

Тип файла:

  • Видеоконтент:
    • video/mp4
  • Аудиоконтент:
    • audio/mpeg
  • Документ:
    • application/pdf
    • application/epub+zip
    • text/plain
required
Array of objects (ChunkPart)

Для оптимальной скорости загрузки контента следует разбить файл на фреймы по 2 Мб. В массиве указываются индекс каждого фрейма и его размер

required
object or null (ContentMeta)

Метаданные. Дополнительная информация о контенте

Responses

Request samples

Content type
application/json
{
  • "title": "Книга `Иван Тургенев: Отцы и дети'",
  • "description": "Очень хорошая книга.",
  • "catalog_id": 4,
  • "content_type": "application/epub+zip",
  • "parts": [
    ],
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "content_id": 493292,
  • "uuid": "25f5e4c9-2cac-11ef-adbf-9cc2c45608a"
}

Загрузить контент (файл){{ /api/v1/content/upload/chunk }}

Описание метода

Метод позволяет загрузить контент (файл) по частям.

Краткая инструкция по применению:

  1. Разбейте файл на части размером не более 2 Мб.
  2. Для каждой части файла:
  • Убедитесь, что заголовок X-Content-Type соответствует типу вашего контента (например, video/mp4, audio/mpeg, application/pdf и т.д.).
  • Установите заголовок X-Wbd-Part-Index в соответствии с индексом текущей части (начиная с 1).
  • Укажите uuid контента в заголовке X-Wbd-Content-Uuid, который вы получили при инициализации нового контента.
  • Отправьте байты (часть файла) в теле запроса.
  1. Повторяйте шаг 2 для всех частей файла до завершения загрузки.
Максимум 10 запросов в секунду
Authorizations:
ApiKeyAuth
header Parameters
X-Content-Type
required
string
Enum: "video/mp4" "audio/mpeg" "text/plain" "application/pdf" "application/zip" "application/epub+zip"

Тип файла

X-Wbd-Part-Index
required
integer <int64>

Индекс фрейма (части контента)

X-Wbd-Content-Uuid
required
string

Уникальный ID полученный в инициализации нового контента

Request Body schema: application/octet-stream
required
string <binary>

Байты файла

Responses

Response samples

Content type
application/json
{
  • "chunk": 3,
  • "uri": "vol19/924/e9e5d152ea3d9018bd061c62f75efbdf/content"
}

Редактировать контент{{ /api/v1/content/author/{content_id} }}

Описание метода

Метод позволяет редактировать информацию о контенте.

Максимум 50 запросов в секунду
Authorizations:
ApiKeyAuth
path Parameters
content_id
required
integer <int64>

ID контента

Request Body schema: application/json
required
title
string or null <= 500 characters

Название контента.
Максимальная длина — 500 символов.

description
string or null <= 1000 characters

Описание контента.
Максимальная длина — 1000 символов.

Responses

Request samples

Content type
application/json
{
  • "title": "Книга 'Иван Тургенев: Отцы и дети'",
  • "description": "Очень хорошая книга."
}

Response samples

Content type
application/json
{
  • "id": 5321,
  • "author_id": 93224,
  • "title": "Книга 'Иван Тургенев: Отцы и дети'",
  • "description": "Очень хорошая книга.",
  • "content_type": "application/epub+zip",
  • "uri": "vol19/924/e9e55159ea3d9018bd061c62f75efbdf/content",
  • "files": [
    ],
  • "playlist": "vol14/147/f2671cfb67bd8c200b9464vd6f0dd97d/output.m3u8",
  • "meta": null,
  • "category_id": 4,
  • "status": 2,
  • "created": "2024-06-10T07:29:30Z",
  • "updated": "2024-06-17T22:12:13Z"
}

Получить информацию о контенте{{ /api/v1/content/author/{content_id} }}

Описание метода

Метод позволяет получить информацию о конкретном контенте.

Максимум 50 запросов в секунду
Authorizations:
ApiKeyAuth
path Parameters
content_id
required
integer <int64>

ID контента

Responses

Response samples

Content type
application/json
{
  • "id": 5321,
  • "author_id": 93224,
  • "title": "Книга 'Иван Тургенев: Отцы и дети'",
  • "description": "Очень хорошая книга.",
  • "content_type": "application/epub+zip",
  • "uri": "vol19/924/e9e55159ea3d9018bd061c62f75efbdf/content",
  • "files": [
    ],
  • "playlist": "vol14/147/f2671cfb67bd8c200b9464vd6f0dd97d/output.m3u8",
  • "meta": null,
  • "category_id": 4,
  • "status": 2,
  • "created": "2024-06-10T07:29:30Z",
  • "updated": "2024-06-17T22:12:13Z"
}

Получить список своего контента{{ /api/v1/content/author }}

Описание метода

Метод позволяет получить список своего контента с использованием фильтрации.

Описание параметров фильтрации

  • search — Поиск контента по названию. Укажите часть или полное название контента для поиска.
  • category — Фильтрация контента по категории. Список категорий находится в таблице, колонка — catalog_id — Идентифицировать категории.
  • status — Фильтрация контента по статусу. Возможные значения:
    • 0 — Создан
    • 1 — Загружено на сервер
    • 2 — Опубликован
    • 3 — Ошибка в обработке или публикации
    • 4 — Обрабатывается
    • 5 — Отправлено на сервер
  • sort — Сортировка контента по дате создания или обновления. Укажите created для сортировки по дате создания и updated для сортировки по дате обновления.
  • sort_dir — Направление сортировки. Укажите asc для сортировки по возрастанию или desc для сортировки по убыванию.
  • skip — Смещение. Позволяет пропустить определенное количество контента в результирующем наборе.
    Например, если skip равно 20, то выборка начнется с 21 записи.
  • take — Количество контента, которое нужно вернуть в ответе.
    Например, если take равно 10, то в ответе будет не более 10 записей.
Максимум 100 запросов в секунду
Authorizations:
ApiKeyAuth
query Parameters
search
string

Поиск по названию контента

category
integer <int64>
Enum: 1 2 4

Фильтрация по категории:

  • 1 — Видеоконтент
  • 2 — Аудиоконтент
  • 4 — Документ
status
integer <int32>
Enum: 0 1 2 3 4 5

Фильтрация по статусу:

  • 0 — Создан
  • 1 — Загружено на сервер
  • 2 — Опубликован
  • 3 — Ошибка в обработке или публикации
  • 4 — Обрабатывается
  • 5 — Отправлено на сервер
sort
string
Enum: "created" "updated"

Сортировка контента по дате создания или обновления

sort_dir
string
Enum: "asc" "desc"

Направление сортировки:

  • asc — по возрастанию
  • desc — по убыванию
skip
integer <int64>
Default: 0

Смещение. Количество контента, которые нужно пропустить в результирующем наборе.

take
integer <int64>
Default: 50

Количество контента для получения

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 10
}

Скачать контент{{ /api/v1/content/download/{uri} }}

Описание метода

Метод позволяет скачать контент по URI.

Получение URI-адреса контента

  1. Воспользуйтесь одним из методов для получения информации о контенте.
  2. В информации о контенте возьмите URI-адрес из поля uri или files.

Скачивание контента частями

Вы можете скачать файл частями с использованием заголовка Range.

Пример: Range: bytes=0-524287999

Ответ содержит заголовок Content-Range с информацией о скаченном файле.

Пример: Content-Range: bytes 0-524287999/1073741824

Максимум 10 запросов в секунду
Authorizations:
ApiKeyAuth
path Parameters
uri
required
string

URI-адрес контента

header Parameters
Range
string

Позволять скачивать файл частями.

Пример: bytes=0-524287999

Responses

Response samples

Content type
application/json
{
  • "status": 401,
  • "title": "unauthorized",
  • "detail": "authorization required",
  • "code": "string",
  • "requestId": "b709d59bd0791513350332ffe5f813c1",
  • "origin": "gateway-dev"
}

Удалить контент{{ /api/v1/content/delete }}

Описание метода

Метод позволяет удалить контент по ID.

Максимум 50 запросов в секунду
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
content_id
integer <int64>

ID контента

Responses

Request samples

Content type
application/json
{
  • "content_id": 493292
}

Response samples

Content type
application/json
{
  • "status": 401,
  • "title": "unauthorized",
  • "detail": "authorization required",
  • "code": "string",
  • "requestId": "b709d59bd0791513350332ffe5f813c1",
  • "origin": "gateway-dev"
}

Загрузить медиафайлы для предложения{{ /api/v1/content/gallery }}

Описание метода

Метод позволяет загружать медиафайлы на сервер.

После успешной загрузки возвращает список URI-адресов, которые можно использовать для добавления дополнительных медиафайлов в предложение.

Данный метод поможет вам добавить дополнительные медиафайлы при создании или обновлении предложения.

Ограничения по размеру:
  • изображение: 5 Мб
  • видео: 50 Мб
  • общий размер всех файлов: 100 Мб
Допустимые форматы:
  • изображение: PNG, JPEG
  • видео: MP4
Можно передать до 8 медиафайлов.
Максимум 10 запросов в секунду
Authorizations:
ApiKeyAuth
Request Body schema: multipart/form-data
required
files
required
Array of strings <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
{
  • "uris": [
    ]
}

Ключи активации

Добавить ключи активации{{ /api/v1/keys-api/keys }}

Описание метода

Метод позволяет добавить ключи для предложения по ID.

Предложение должно быть из категории (section):
  • Ключи активации — 3
  • Купоны и развлечения — 12
  • Подарочные сертификаты — 13
Максимум 50 запросов в секунду
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
keys
required
Array of strings <= 1000 items [ items <= 200 characters ]

Список ключей.

Ограничения:

  • Максимальное количество ключей — 1000
  • Максимальная длина ключа — 200 символов
offer_id
required
integer <int64>

ID предложения

Responses

Request samples

Content type
application/json
{
  • "keys": [
    ],
  • "offer_id": 4251
}

Response samples

Content type
application/json
{
  • "status": 401,
  • "title": "unauthorized",
  • "detail": "authorization required",
  • "code": "string",
  • "requestId": "b709d59bd0791513350332ffe5f813c1",
  • "origin": "gateway-dev"
}

Удалить ключи активации{{ /api/v1/keys-api/keys }}

Описание метода

Метод позволяет удалить ключи активации по их ID.

Доступ к методу предоставляется через заявку в техническую поддержку.
Максимум 100 запросов в секунду
Authorizations:
ApiKeyAuth
query Parameters
ids
required
Array of integers <int64> [ items <int64 > ]

Список ID ключей

Responses

Response samples

Content type
application/json
{
  • "statuses": [
    ]
}

Получить купленные ключи{{ /api/v1/keys-api/keys/redeemed }}

Описание метода

Метод позволяет получить список купленных ключей с использованием фильтрации.

Описание параметров фильтрации

  • offer_id — Фильтрация по ID предложения. Позволяет выбрать ключи, связанные с определенным предложением.
  • skip — Смещение. Указывает, сколько записей нужно пропустить в результирующем наборе.
    Например, если skip равно 20, то выборка начнется с 21 записи.
  • take — Количество записей для получения. Указывает, сколько ключей должно быть возвращено в ответе.
    Например, если take равно 10, то в ответе будет не более 10 записей.
  • date_from — Фильтрация по дате покупки начиная с указанной даты (включительно).
    Формат даты: RFC3339.
  • date_to — Фильтрация по дате покупки до указанной даты (не включительно).
    Формат даты: RFC3339.
Максимум 100 запросов в секунду
Authorizations:
ApiKeyAuth
query Parameters
offer_id
integer <int64>

Фильтрация по ID предложения. Позволяет выбрать ключи, связанные с определенным предложением

skip
integer <int64>
Default: 0

Смещение. Указывает, сколько записей нужно пропустить в результирующем наборе. Используется для пагинации

take
integer <int64>
Default: 50

Количество записей для получения. Указывает, сколько ключей должно быть возвращено в ответе

date_from
string

Фильтрация по дате покупки начиная с указанной даты (включительно).

Формат даты: RFC3339 (2023-06-17T19:20:30Z)

date_to
string

Фильтрация по дате покупки до указанной даты (не включительно).

Формат даты: RFC3339 (2024-10-18T19:20:30Z)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 10
}

Получить количество ключей для предложения{{ /api/v1/offer/keys/{offer_id} }}

Описание метода

Метод позволяет получить информацию о количестве ключей у конкретного предложения.

Максимум 100 запросов в секунду
Authorizations:
ApiKeyAuth
path Parameters
offer_id
required
integer <int64>

ID предложения

Responses

Response samples

Content type
application/json
{
  • "total": 10,
  • "available": 5,
  • "reserved": 2,
  • "deleted": 2
}

Получить список ключей{{ /api/v1/offer/keys/{offer_id}/list }}

Описание метода

Метод позволяет получить список загруженных вами ключей для конкретного предложения.

Доступ к методу предоставляется через заявку в техническую поддержку.
Максимум 100 запросов в секунду
Authorizations:
ApiKeyAuth
path Parameters
offer_id
required
integer <int64>

ID предложения

query Parameters
take
integer <uint32>
Default: 50

Количество записей для получения. Указывает, сколько ключей должно быть возвращено в ответе

skip
integer <uint32>
Default: 0

Смещение. Указывает, сколько записей нужно пропустить в результирующем наборе. Используется для пагинации

deleted
boolean
Default: true

Указывает, будут ли в ответе присутствовать удалённые ключи

sold
boolean
Default: true

Указывает, будут ли в ответе присутствовать проданные ключи

reserved
boolean
Default: true

Указывает, будут ли в ответе присутствовать зарезервированные ключи

expired
boolean
Default: true

Указывает, будут ли в ответе присутствовать ключи с истекшим сроком действия

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 10
}